Page Contents
- リクエストとレスポンスオブジェクト
- リクエスト
- レスポンス
- クッキーの設定
- クロスオリジンリクエストヘッダー(CORS)の設定
- 不変レスポンスに伴うよくある失敗
- クッキーコレクション
リクエストとレスポンスオブジェクトは、HTTP リクエストとレスポンスの周辺の抽象化を提供します。 CakePHP のリクエストオブジェクトは、入ってきたリクエストを省みることができる一方、 レスポンスオブジェクトは容易にコントローラーから HTTP レスポンスを作成することができます。
ServerRequest
は、CakePHP で使用されるデフォルトのリクエストオブジェクトです。
リクエストデータへの応答と対話が中心的な機能となります。リクエストごとに Request は一つ作られ、
リクエストデータを使うアプリケーションの様々なレイヤーに参照が渡されます。
デフォルトのリクエストは $this->request
に設定され、コントローラー、セル、ビュー、
ヘルパーの中で利用できます。またコントローラーの参照を使うことでコンポーネントの中からも
アクセスすることが出来ます。 ServerRequest
の役割は以下の通りです。
GET, POST, そして FILES 配列を慣れ親しんだデータ構造に変換する処理を行います。
リクエストに関連する内省的環境を提供します。送信されたヘッダーやクライアントの IP アドレス、 サーバーが実行されているサブドメイン/ドメインの情報などが含まれます。
リクエストパラメーターへのアクセス方法をインデックス付き配列とオブジェクトのプロパティーの 両方の形式で提供します。
3.4.0 以降、 CakePHP のリクエストオブジェクトは、CakePHP の外部のライブラリーを 使用しやすくするため PSR-7 ServerRequestInterface を実装します。
リクエストは、 getParam()
メソッドを介して、ルーティングパラメーターを用意しています。
$controllerName = $this->request->getParam('controller');
// 3.4.0 より前
$controllerName = $this->request->param('controller');
全てのルーティングパラメーターを配列として取得するためには getAttribute()
を使用します。
$params = $this->request->getAttribute('params');
すべての ルート要素 は、このインターフェイスを通してアクセスされます。
ルート要素 に加えて 渡された引数 へのアクセスがしばしば必要になります。 これらは両方ともリクエストオブジェクトと同様に利用可能です。
// 渡された引数
$passedArgs = $this->request->getParam('pass');
すべての渡された引数にアクセスする方法が提供されています。この中には CakePHP の内部で使っている 重要で役に立つパラメーターが存在し、また、リクエストパラメーターの中ですべて見つけられます。
plugin
リクエストを処理するプラグインです。プラグインが存在しない場合は null になります。
controller
現在のリクエストを処理するコントローラーです。
action
現在のリクエストを処理するアクションです。
prefix
現在のアクションのプレフィックスです。詳しくは、 プレフィックスルーティング をご覧ください。
クエリー文字列パラメーターは、 getQuery()
メソッドを使って読み取ることができます。
// URL は /posts/index?page=1&sort=title
$page = $this->request->getQuery('page');
// 3.4.0 より前
$this->request->query('page');
query プロパティーに直接アクセスするか、エラーが発生しない方法で URL クエリー配列を読むために
getQuery()
メソッドを使用することができます。キーが存在しない場合、 null
が返ります。
$foo = $this->request->getQuery('value_that_does_not_exist');
// $foo === null
// デフォルト値も提供できます。
$foo = $this->request->getQuery('does_not_exist', 'default val');
getQueryParams()
を使用すると全てのクエリー文字列パラメーターにアクセスできます。
$query = $this->request->getQueryParams();
バージョン 3.4.0 で追加: getQueryParams()
と getQuery()
は 3.4.0 で追加されました。
すべての POST データは Cake\Http\ServerRequest::getData()
を使ってアクセスされます。
フォームデータが data
接頭辞を含んでいる場合、接頭辞は取り除かれるでしょう。例えば:
// name 属性が 'MyModel[title]' の入力は次のようにアクセスします。
$title = $this->request->getData('MyModel.title');
キーが存在しない場合、 null
が返ります。
$foo = $this->request->getData('Value.that.does.not.exist');
// $foo == null
REST サービスを構築しているとき PUT
と DELETE
リクエストのデータを受付けることが
よくあります。 application/x-www-form-urlencoded
リクエストボディーのデータは
PUT
と DELETE
リクエストでは自動的に構文解析され $this->data
に設定されます。
もし JSON や XML データを受け付けている場合、どうやってリクエストボディーにアクセスすればいいのかに
ついては以下の説明を見て下さい。
入力されたデータにアクセスする場合、オプション機能でそれをデコードすることができます。
XML や JSON のリクエストボディーのコンテンツと対話するときに便利です。
デコード機能のための追加のパラメーターは、 input()
の引数として渡すことができます。
$jsonData = $this->request->input('json_decode');
ServerRequest::env()
は、 env()
グローバル関数のラッパーで、グローバルな
$_SERVER
や $_ENV
を変更することなくゲッター/セッターとして動作します。
// ホストの取得
$host = $this->request->env('HTTP_HOST');
// 値を設定。一般的にはテストに役立ちます。
$this->request->env('REQUEST_METHOD', 'POST');
getServerParams()
を使用すると、全ての環境変数にアクセスできます。
$env = $this->request->getServerParams();
バージョン 3.4.0 で追加: getServerParams()
は、3.4.0 で追加されました。
REST を採用しているアプリケーションでは URL エンコードされていない
post 形式でデータを交換することがしばしばあります。 input()
を使用すると、任意の形式の入力データを読み込むことができます。
デコード関数が提供されることでデシリアライズされたコンテンツを受け取ることができます。
// PUT/POST アクションで投稿されたデータを JSON 形式にエンコードで取得する
$jsonData = $this->request->input('json_decode');
json_decode
で「結果を配列として受け取る」パラメーターのように、デシリアライズメソッドの中には
呼び出し時に追加パラメーターが必要なものがあります。同様に、 Xml を DOMDocument オブジェクトに
変換したい場合、 input()
は、
追加のパラメーターを渡すことができます。
// PUT/POST アクションで投稿されたデータを XML エンコードで取得する
$data = $this->request->input('Cake\Utility\Xml::build', ['return' => 'domdocument']);
リクエストオブジェクトはまたアプリケーションのパスについての役立つ情報を提供しています。
base
や webroot
属性は URL の生成や、 アプリケーションが
サブディレクトリーにいるのかどうかの決定に役立ちます。様々な属性が使用できます。
// 現在のリクエスト URL が /subdir/articles/edit/1?page=1 であると仮定
// /subdir/articles/edit/1?page=1 を保持
$here = $request->getRequestTarget();
// /subdir を保持
$base = $request->getAttribute('base');
// /subdir/ を保持
$base = $request->getAttribute('webroot');
// 3.4.0 より前
$webroot = $request->webroot;
$base = $request->base;
$here = $request->here();
リクエストオブジェクトは、特定のリクエストに一定の条件を検査する簡単な方法を提供します。
is()
メソッドを使用することで、多くの一般的な条件を確認するだけでなく、
他のアプリケーション固有の要求基準を検査することができます。
$isPost = $this->request->is('post');
新しい種類の検出器を作成するために Cake\Http\ServerRequest::addDetector()
を使用することで利用可能なリクエスト検出器を拡張することができます。4種類の異なる検出器を作成できます。
環境変数の比較 - 環境変数の比較、 env()
から取得された値と提供された値が
等しいかどうかを比較します。
パターン値の比較 - パターン値の比較では env()
から取得された値と正規表現を比較します。
オプションベースの比較 - オプションベースの比較では正規表現を作成するためにオプションのリストを使います。 既に定義済みのオプション検出器を追加するための呼び出しはオプションをマージするでしょう。
コールバック検出器 - コールバック検出器はチェックをハンドリングするために 'callback' タイプを 提供します。コールバックはパラメーターとしてだけリクエストオブジェクトを受け取ります。
いくつかの例:
// environment detector の追加
$this->request->addDetector(
'post',
['env' => 'REQUEST_METHOD', 'value' => 'POST']
);
// pattern value detector の追加
$this->request->addDetector(
'iphone',
['env' => 'HTTP_USER_AGENT', 'pattern' => '/iPhone/i']
);
// option detector の追加
$this->request->addDetector('internalIp', [
'env' => 'CLIENT_IP',
'options' => ['192.168.0.101', '192.168.0.100']
]);
// callback detector を追加。有効な callable 形式でなければなりません。
$this->request->addDetector(
'awesome',
function ($request) {
return $request->getParam('awesome');
}
);
// 追加の引数を使用する検出器を追加。3.3.0 以降。
$this->request->addDetector(
'controller',
function ($request, $name) {
return $request->getParam('controller') === $name;
}
);
Request
は、 Cake\Http\ServerRequest::domain()
、
Cake\Http\ServerRequest::subdomains()
、
Cake\Http\ServerRequest::host()
のようにサブドメインで
アプリケーションを助けるためのメソッドを含みます。
利用可能な組み込みの検出器は以下の通りです。
is('get')
現在のリクエストが GET かどうかを調べます。
is('put')
現在のリクエストが PUT かどうかを調べます。
is('patch')
現在のリクエストが PATCH かどうかを調べます。
is('post')
現在のリクエストが POST かどうかを調べます。
is('delete')
現在のリクエストが DELETE かどうかを調べます。
is('head')
現在のリクエストが HEAD かどうかを調べます。
is('options')
現在のリクエストが OPTIONS かどうかを調べます。
is('ajax')
現在のリクエストが X-Requested-With = XMLHttpRequest
に由来するものかどうかを調べます。
is('ssl')
リクエストが SSL 経由かどうかを調べます。
is('flash')
リクエストに Flash の User-Agent があるかどうかを調べます。
is('requested')
リクエストに、値が1のクエリーパラメーター 「requested」があるかどうかを調べます。
is('json')
リクエストに 「json」 の拡張子を持ち 「application/json」
MIME タイプを受付けるかどうかを調べます。
is('xml')
リクエストが 「xml」拡張子を持ち、「application/xml」または「text/xml」
MIME タイプを受付けるかどうかを調べます。
バージョン 3.3.0 で追加: 3.3.0 から検出器は追加のパラメーターが受け取れます。
特定のリクエストのセッションにアクセスするには、 session()
メソッドを使用します。
$userName = $this->request->session()->read('Auth.User.name');
詳細については、セッションオブジェクトを使用する方法のための セッション ドキュメントを参照してください。
アプリケーションが実行されているドメイン名を返します。
// 'example.org' を表示
echo $request->domain();
アプリケーションが実行されているサブドメインを配列で返します。
// 'my.dev.example.org' の場合、 ['my', 'dev'] を返す
$subdomains = $request->subdomains();
アプリケーションのホスト名を返します。
// 'my.dev.example.org' を表示
echo $request->host();
リクエストの HTTP メソッドを返します。
// POST を出力
echo $request->getMethod();
// 3.4.0 より前
echo $request->method();
許可された HTTP メソッドを設定します。
もしマッチしなかった場合、 MethodNotAllowedException
を投げます。
405 レスポンスには、通過できるメソッドを持つ Allow
ヘッダーが含まれます。
public function delete()
{
// POST と DELETE のリクエストのみ受け入れます
$this->request->allowMethod(['post', 'delete']);
...
}
リクエストで使われている HTTP_*
ヘッダーにアクセスできます。
例えば:
// 文字列としてヘッダーを取得
$userAgent = $this->request->getHeaderLine('User-Agent');
// 全ての値を配列で取得
$acceptHeader = $this->request->getHeader('Accept');
// ヘッダーの存在を確認
$hasAcceptHeader = $this->request->hasHeader('Accept');
// 3.4.0 より前
$userAgent = $this->request->header('User-Agent');
いくつかの apache インストール環境では、 Authorization
ヘッダーにアクセスできませんが、
CakePHP は、必要に応じて apache 固有のメソッドを介して利用できるようにします。
リクエストのリファラーを返します。
現在アクセスしているクライアントの IP アドレスを返します。
アプリケーションがロードバランサーの背後にあったり、クラウドサービス上で実行されている場合、
しばしばリクエストでロードバランサーのホスト、ポートおよびスキームを取得します。
多くの場合、ロードバランサーはまた、オリジナルの値として HTTP-X-Forwarded-*
ヘッダーを送信します。
転送されたヘッダーは、CakePHP によって使用されることはありません。リクエストオブジェクトで
これらのヘッダーを使用するには、 trustProxy
プロパティーを true
に設定します。
$this->request->trustProxy = true;
// これらのメソッドがプロキシーのヘッダーを使用するようになります。
$port = $this->request->port();
$host = $this->request->host();
$scheme = $this->request->scheme();
$clientIp = $this->request->clientIp();
クライアントがどのコンテンツタイプを受付けるかを調べます。また、特定のコンテンツタイプが 受付られるかどうかを調べます。
すべてのタイプを取得:
$accepts = $this->request->accepts();
あるタイプについての確認:
$acceptsJson = $this->request->accepts('application/json');
クライアントが受付けるすべての言語を取得します。また、特定の言語が受付られるかどうかを調べます。
受付られる言語のリストを取得:
$acceptsLanguages = $this->request->acceptLanguage();
特定の言語が受付られるかどうかの確認:
$acceptsSpanish = $this->request->acceptLanguage('es-es');
Cake\Http\Response
は、CakePHP のデフォルトのレスポンスクラスです。
いくつかの機能と HTTP レスポンスの生成をカプセル化します。
また送信予定のヘッダーを調べるためにモックやスタブとしてテストの手助けをします。
Cake\Http\ServerRequest
と同様に、 Controller
,
RequestHandlerComponent
及び Dispatcher
に以前あった多くのメソッドを
Cake\Http\Response
が統合します。
古いメソッドは非推奨になり、 Cake\Http\Response
の使用を推奨します。
Response
は次のような共通のレスポンスをラップするためのインターフェイスを提供します。
リダイレクトのヘッダーを送信。
コンテンツタイプヘッダーの送信。
任意のヘッダーの送信。
レスポンスボディーの送信。
Cake\Http\Response::withType()
を使用して、アプリケーションのレスポンスの
コンテンツタイプを制御することができます。アプリケーションが Response に組み込まれていない
コンテンツの種類に対処する必要がある場合は、以下のように type()
を使って設定することができます。
// vCard タイプを追加
$this->response->type(['vcf' => 'text/v-card']);
// レスポンスのコンテンツタイプを vcard に設定
$this->response = $this->response->withType('vcf');
// 3.4.0 より前
$this->response->type('vcf');
大抵の場合、追加のコンテンツタイプはコントローラーの beforeFilter()
コールバックの中で設定したいと思うので、 RequestHandlerComponent
が提供する
ビューの自動切り替え機能を活用できます。
リクエストに対する応答としてファイルを送信する機会があります。
Cake\Http\Response::withFile()
を使用してそれを達成することができます。
public function sendFile($id)
{
$file = $this->Attachments->getFile($id);
$response = $this->response->withFile($file['path']);
// レスポンスオブジェクトを返すとコントローラーがビューの描画を中止します
return $response;
}
// 3.4.0 より前
$file = $this->Attachments->getFile($id);
$this->response->file($file['path']);
// レスポンスオブジェクトを返すとコントローラーがビューの描画を中止します
return $this->response;
上記の例のようにメソッドにファイルのパスを渡す必要があります。CakePHP は、
Cake\Http\Response::$_mimeTypes に登録された、よく知られるファイルタイプであれば
正しいコンテンツタイプヘッダーを送ります。 Cake\Http\Response::withFile()
を呼ぶ前に
Cake\Http\Response::withType()
メソッドを使って、新しいタイプを追加できます。
もし、あなたが望むなら、 オプションを明記することによって、ブラウザー上に表示する代わりにファイルを ダウンロードさせることができます。
$response = $this->response->withFile(
$file['path'],
['download' => true, 'name' => 'foo']
);
// 3.4.0 より前
$this->response->file(
$file['path'],
['download' => true, 'name' => 'foo']
);
サポートされているオプションは次のとおりです。
name は、ユーザーに送信される代替ファイル名を指定することができます。
ヘッダーでダウンロードを強制するように設定する必要があるかどうかを示すブール値。
動的に生成された pdf や ics のようにディスク上に存在しないファイルを返すことができます。
public function sendIcs()
{
$icsString = $this->Calendars->generateIcs();
$response = $this->response;
// レスポンスのボディーに文字列コンテンツを挿入する (3.4.0 以降)
$response = $response->withStringBody($icsString);
// レスポンスのボディーに文字列コンテンツを挿入する (3.4.0 より前)
$response->body($icsString);
$response = $response->withType('ics');
// 任意のダウンロードファイル名を指定できます
$response = $response->withDownload('filename_for_download.ics');
// レスポンスオブジェクトを返すとコントローラーがビューの描画を中止します
return $response;
}
ヘッダーの設定は Cake\Http\Response::withHeader()
メソッドで行われます。
すべての PSR-7 インターフェイスのメソッドと同様に、このメソッドは新しいヘッダーを含む
新しい インスタンスを返します。
// 一つのヘッダーを追加/置換
$response = $response->withHeader('X-Extra', 'My header');
// 一度に複数ヘッダーを設定
$response = $response->withHeader('X-Extra', 'My header')
->withHeader('Location', 'http://example.com');
// 既存のヘッダーに値を追加
$response = $response->withAddedHeader('Set-Cookie', 'remember_me=1');
// 3.4.0 より前 - 一つのヘッダーを設定
$this->response->header('Location', 'http://example.com');
セットされた際、ヘッダーは送られません。これらのヘッダーは、 Cake\Http\Server
によって
レスポンスが実際に送られるまで保持されます。
便利なメソッド Cake\Http\Response::withLocation()
を使うと
直接リダイレクトヘッダーの設定や取得ができます。
レスポンスボディーとして文字列を設定するには、次のようにします。
// ボディーの中に文字列をセット
$response = $response->withStringBody('My Body');
// json レスポンスにしたい場合
$response = $response->withType('application/json')
->withStringBody(json_encode(['Foo' => 'bar']));
バージョン 3.4.3 で追加: withStringBody()
は 3.4.3 で追加されました。
withBody()
を使って、 Zend\Diactoros\MessageTrait
によって提供される
レスポンスボディーを設定するには、
$response = $response->withBody($stream);
// 3.4.0 より前でボディーを設定
$this->response->body('My Body');
$stream
が Psr\Http\Message\StreamInterface
オブジェクトであることを確認してください。新しいストリームを作成する方法は、以下をご覧ください。
Zend\Diactoros\Stream
ストリームを使用して、
ファイルからレスポンスをストリーム化することもできます。
// ファイルからのストリーム化
use Zend\Diactoros\Stream;
$stream = new Stream('/path/to/file', 'rb');
$response = $response->withBody($stream);
また、 CallbackStream
を使用してコールバックをストリーム化できます。
クライアントへストリーム化する必要のある画像、CSV ファイル もしくは PDF
のようなリソースがある場合に便利です。
// コールバックからのストリーム化
use Cake\Http\CallbackStream;
// 画像の作成
$img = imagecreate(100, 100);
// ...
$stream = new CallbackStream(function () use ($img) {
imagepng($img);
});
$response = $response->withBody($stream);
// 3.4.0 より前では、次のようにストリーミングレスポンスを作成することができます。
$file = fopen('/some/file.png', 'r');
$this->response->body(function () use ($file) {
rewind($file);
fpassthru($file);
fclose($file);
});
レスポンスの中で使われる文字コードの種類を設定します。
$this->response = $this->response->withCharset('UTF-8');
// 3.4.0 より前
$this->response->charset('UTF-8');
時々、コントローラーアクションの結果をキャッシュしないようにブラウザーに強制する必要がでてきます。
Cake\Http\Response::withDisableCache()
はそういった目的で使われます。
public function index()
{
// キャッシュの無効化
$this->response = $this->response->withDisabledCache();
// 3.4.0 より前
$this->response->disableCache();
}
警告
Internet Explorer にファイルを送ろうとしている場合、SSL ドメインからの キャッシュを無効にすることで結果をエラーにすることができます。
クライアントにレスポンスをキャッシュして欲しいことを伝えられます。
Cake\Http\Response::withCache()
を使って:
public function index()
{
// キャッシュの有効化
$this->response = $this->response->withCache('-1 minute', '+5 days');
}
上記の例では、訪問者の体感スピード向上のため、クライアントにレスポンス結果を
5日間キャッシュするように伝えています。
withCache()
メソッドは、第一引数に Last-Modified
ヘッダーの値を設定します。
第二引数に Expires
ヘッダーと max-age
ディレクティブの値を設定します。
Cache-Control の public
ディレクティブも設定されます。
アプリケーションの速度を改善するための簡単で最善の方法の一つは HTTP キャッシュを使う事です。 このキャッシュモデルの元では、modified time, response entity tag などいくつかのヘッダーを 設定することでレスポンスのキャッシュコピーを使うべきかどうかをクライアントが決定できるように 助ける事が求められます。
キャッシュやデータが変更されたときに無効化(更新)するロジックのコードを持つのではなく、 HTTP は二つのモデル、expiration と validation を使います。これらは大抵の場合、 自身でキャッシュを管理するよりかなり単純です。
Cake\Http\Response::withCache()
と独立して、HTTP キャッシュヘッダーを
チューニングするための様々なメソッドが使えます。この点に関して、ブラウザーやリバースプロキシーの
キャッシュよりも有利だと言えます。
キャッシュ制御ヘッダーは expiration モデルの元で使われ、複数の指示を含んでいます。
ブラウザーやプロキシーがどのようにキャッシュされたコンテンツを扱うのかをその指示で変更することができます。
Cache-Control
ヘッダーは以下の通りです。
Cache-Control: private, max-age=3600, must-revalidate
Response
のいくつかのユーティリティメソッドを用いることで、最終的に有効な Cache-Control
ヘッダーを生成します。一つ目は、 withSharable()
メソッドです。
このメソッドは異なるユーザーやクライアントの間で共有出来ることを考慮されたレスポンスかどうかを示します。
このメソッドは実際には、このヘッダーが public
または private
のどちらなのかを制御しています。
private としてレスポンスを設定することは、レスポンスのすべてまたはその一部が特定のユーザー用であることを
示しています。共有キャッシュのメリットを活かすためにはコントロールディレクティブを public に設定する
必要があります。
このメソッドの二番目のパラメーターはキャッシュの max-age
を指定するために使われます。このパラメーターは
レスポンスが古いと見なされる秒数を表しています。
public function view()
{
// ...
// Cache-Control を 3600 秒の間、public として設定
$this->response = $this->response->withSharable(true, 3600);
}
public function my_data()
{
// ...
// Cache-Control を 3600 秒の間、private として設定
$this->response = $this->response->withSharable(false, 3600);
}
Response
は Cache-Control
ヘッダーの中で各コンポーネントを設定するための分割されたメソッドを
公開しています。
Expires
ヘッダーに、レスポンスが古いと見なされる日時を設定できます。
このヘッダーは withExpires()
メソッドを使って設定されます。
public function view()
{
$this->response = $this->response->withExpires('+5 days');
}
またこのメソッドは、DateTime
インスタンスや DateTime
クラスによって
構文解析可能な文字列を受け付けます。
HTTP におけるキャッシュの検証はコンテンツが定期的に変化するような場合によく使われ、 キャッシュが古いと見なせる場合にのみレスポンスコンテンツが生成されることをアプリケーションに求めます。 このモデルのもとでは、クライアントはページを直接使う代わりにキャッシュの中に保存し続け、 アプリケーションに毎回リソースが変更されたかどうかを尋ねます。 これは画像や他のアセットといった静的なリソースに対して使われる場合が多いです。
withEtag()
メソッド (entity tag と呼ばれる) は要求されたリソースを
識別するための一意な文字列です。大抵の場合はファイルのチェックサムのようなもので、
リソースが一致するかどうかを調べるためにキャッシュはチェックサムを比較するでしょう。
実際にこのヘッダーを使うメリットを得るためには、手動で
checkNotModified()
メソッドを呼び出すかコントローラーに
リクエストハンドリング を読み込まなければなりません。
public function index()
{
$articles = $this->Articles->find('all');
$response = $this->response->withEtag($this->Articles->generateHash($articles));
if ($response->checkNotModified($this->request)) {
return $response;
}
$this->response = $response;
// ...
}
注釈
ほとんどのプロキシーユーザーは、おそらくパフォーマンスと互換性の理由から、Etags の代わりに Last Modified ヘッダーの使用を検討してください。
HTTP キャッシュの検証モデルのもとでは、リソースが最後に変更された日時を示すために
Last-Modified
ヘッダーを設定することができます。このヘッダーを設定すると CakePHP が
キャッシュしているクライアントにレスポンスが変更されたのかどうかを返答する手助けとなります。
実際にこのヘッダーを使うメリットを得るためには、
checkNotModified()
メソッドを呼び出すかコントローラーに
リクエストハンドリング を読み込まなければなりません。
public function view()
{
$article = $this->Articles->find()->first();
$response = $this->response->withModified($article->modified);
if ($response->checkNotModified($this->request)) {
return $response;
}
$this->response;
// ...
}
時には同じ URL で異なるコンテンツを提供したいと思うかもしれません。
これは多国語対応ページがある場合やブラウザーごとに異なる HTML を返すようなケースでしばしばおこります。
そのような状況では Vary
ヘッダーを使えます。
$response = $this->response->withVary('User-Agent');
$response = $this->response->withVary('Accept-Encoding', 'User-Agent');
$response = $this->response->withVary('Accept-Language');
リクエストオブジェクトとレスポンスのキャッシュヘッダーを比較し、まだキャッシュが有効かどうかを決定します。 もしまだ有効な場合、レスポンスのコンテンツは削除され 304 Not Modified ヘッダーが送られます。
// コントローラーアクションの中で
if ($this->response->checkNotModified($this->request)) {
return $this->response;
}
3.2 から、 HTTP アクセス制御 関連の
ヘッダーを定義するために、流れるようなインターフェイスの cors()
メソッドが使用できます。
$this->response->cors($this->request)
->allowOrigin(['*.cakephp.org'])
->allowMethods(['GET', 'POST'])
->allowHeaders(['X-CSRF-Token'])
->allowCredentials()
->exposeHeaders(['Link'])
->maxAge(300)
->build();
以下の基準が満たされた場合のみ、 CORS 関連ヘッダーはレスポンスに適用されます。
リクエストは Origin
ヘッダーがあります。
リクエストの Origin
値が許可された Origin 値のいずれかと一致します。
バージョン 3.2 で追加: CorsBuilder
は 3.2 で追加されました。
CakePHP 3.4.0 以降、レスポンスオブジェクトはレスポンスを不変オブジェクトとして扱う
いくつかのメソッドを提供しています。不変オブジェクトは、偶発的な副作用の追跡を困難になるのを予防し、
その変更順序のリファクタリングに起因するメソッド呼び出しに起因する間違いを減らします。
それらは多くの利点を提供しますが、不変オブジェクトには慣れが必要です。
with
で始まるメソッドは、レスポンスに対して不変な方法で動作し、
常に 、 新しい インスタンスを返します。変更されたインスタンスを保持し忘れるのは、
不変オブジェクトを扱うときに人々が最も頻繁にする失敗です。
$this->response->withHeader('X-CakePHP', 'yes!');
上記のコードでは、レスポンスは X-CakePHP
ヘッダーがありません。
withHeader()
メソッドの戻り値を保持していないためです。
上記のコードを修正するには、次のように記述します。
$this->response = $this->response->withHeader('X-CakePHP', 'yes!');
CookieCollection
オブジェクトは、リクエストオブジェクトとレスポンスオブジェクトから
アクセス可能です。イミュータブルパターンを使ってクッキーのグループとやり取りすることができ、
リクエストとレスポンスの不変性が維持されます。
CookieCollection
インスタンスを取得すると、それに含まれるクッキーにアクセスできます。
// クッキーが存在するかどうかをチェック
$cookies->has('remember_me');
// コレクション内のクッキーの数を取得
count($cookies);
// クッキーインスタンスを取得
$cookie = $cookies->get('remember_me');
Cookie
オブジェクトを取得すると、その状態をやりとりしたり変更したりできます。
クッキーは不変なので、クッキーを変更した場合にコレクションを更新する必要があることに
注意してください。
// 値の取得
$value = $cookie->getValue()
// JSON 値の中のデータにアクセス
$id = $cookie->read('User.id');
// 状態のチェック
$cookie->isHttpOnly();
$cookie->isSecure();
バージョン 3.5.0 で追加: CookieCollection
と Cookie
は 3.5.0 で追加されました。