CakePHP3でCookieを保存、呼び出し、削除の操作・CakePHP3.7対応

2019/08/03

CakePHP3でCookieを保存、呼び出し、削除の操作

CakePHP3では Cookieの仕様が度々変更されている

　
システム開発において、Cookieは便利で役に立つ機能です。
　
ですが、CakePHP3ではその Cookieの使用方法がたびたび変更されています。
さらには、その使用方法が Cookbookなどのドキュメントへの反映されるのが遅れているようで、どうやって使えばいいのか混乱が広がっているようです。
　
というわけで、CakePHP3.7で Cookieを使う方法を解説します。
　
　

Cookieを使うために use句を指定

　
まず、Cookieを使うためには下記の use句を追加します。
　

use Cake\Http\Cookie\Cookie;
use Cake\I18n\Time;

1 2	use Cake\Http\Cookie\Cookie; use Cake\I18n\Time;

　
「use Cake\I18n\Time」の方は、Cookieの有効期限を「+1 year」のように指定するためのものです。
具体的な日時を指定する場合は必要ありません。
　
　

Cookieに値を保存する方法

　
Cookieに値を保存する場合は、下記のように記述します。
「key」が Cookieの変数名を指定するところで、「value」が Cookieに保存する値を指定するところです。
　

$this->response = $this->response->withCookie(new Cookie("key","value"));

1	$this->response = $this->response->withCookie(new Cookie("key","value"));

　
これだけでは、ブラウザを閉じると Cookieが消えてしまいますので、Cookieの有効時間等を指定する場合は下記のように指定します。
　

$this->response = $this->response->withCookie(new Cookie("key","value",new Time("+1 year"),"/","example.com",false,false));

1	$this->response = $this->response->withCookie(new Cookie("key","value",new Time("+1 year"),"/","example.com",false,false));

　
上記を分かりやすくビルダーメソッドを使用して記述する場合は以下のようになります。
　

$cookie = (new Cookie("key"))
            ->withValue("value")
            ->withExpiry(new Time("+1 year"))
            ->withPath("/")
            ->withDomain("example.com")
            ->withSecure(false)
            ->withHttpOnly(false);
$this->response = $this->response->withCookie($cookie);

$cookie = (new Cookie("key"))

->withValue("value")

->withExpiry(new Time("+1 year"))

->withPath("/")

->withDomain("example.com")

->withSecure(false)

->withHttpOnly(false);

$this->response = $this->response->withCookie($cookie);

1項目目、キーの設定

　
Cookieを保存するキー（変数名）を指定します。
必須項目です。
　
　

2項目目、withValue()

　
Cookieに保存する値を指定します。
値、項目がない場合は、該当のキーの Cookieを削除します。（保存してある Cookieを削除します。）
　
　

3項目目、withExpiry()

　
Cookieを保持する有効期限を指定します。
指定しない場合は、ブラウザを閉じるまでが有効期限になります。
　
上記のサンプルは「+1 year」を指定していますので、1年間有効になります。
同様の記述の場合は、アクセスの度に Cookieの有効期限がアクセス日時の 1年後に更新されます。
　
また、「2019-01-01 12:00:00」のように具体的な日時を指定することもできます。
「2019-01-01」のように時間を指定しない場合は「00：00：00」がデフォルトでセットされます。
過去日を指定した場合は、該当のキーの Cookieを削除します。（保存してある Cookieを削除します。）
　
　

4項目目、withPath()

　
Cookieを有効とするパスを指定します。
特定のフォルダの中でのみ Cookieが有効となるようにしたい場合は、そのフォルダを指定します。
指定しない場合のデフォルト値は「/」で、サイト全体が有効になっています。
　
　

5項目目、withDomain()

　
Cookieを有効とするドメインを指定します。
指定がある場合は、記述があるドメインでのみ Cookieが有効になります。
指定がない場合のデフォルト値は「””」で、ドメインに関係なく Cookieは有効になります。
　
ちなみに、XAMPPなどのローカル環境では「localhost」を指定します。
（「http://localhost:8080」などのポート番号付きでアクセスしている場合も「localhost」を指定します。）
　
　

6項目目、withSecure()

　
HTTPS接続のときのみ Cookieを扱うようにするか、しないか、を指定します。
デフォルトは「false」で、HTTPでも Cookieを利用できますが、「true」にするとセキュアな HTTPSでアクセスした場合のみ Cookieの生成、アクセスが可能になります。
　
　

7項目目、withHttpOnly()

　
HTTPによるアクセスのときのみアクセスができるようにするか、しないか、を指定します。
デフォルトは「false」です。「true」にすると JavaScriptから Cookieにはアクセスできなくなります。
　
　

Cookieに保存した値を取り出す方法

　
Cookieに保存した値を取り出す場合は、下記のように「getCookie()」を使います。
　

$cookieData = $this->request->getCookie("key");
echo $cookieData;

1 2	$cookieData = $this->request->getCookie("key"); echo $cookieData;

　
Cookieを保存する場合は「response」ですが、値を取り出す場合は「response」ではなく「request」です。
　
　

「$_SERVER」を利用して確認する方法

　
デバッグ時など、Cookieに保存されている情報を確認したい場合は、下記の通り「$_SERVER」を利用する方法もあります。
　

print_r($_SERVER["HTTP_COOKIE"]);

1	print_r($_SERVER["HTTP_COOKIE"]);

「$_COOKIE」を利用して確認する方法

　
デバッグ時など、Cookieに保存されている情報を確認したい場合は、下記の通り「$_COOKIE」を利用する方法もあります。
　

print_r($_COOKIE);

1	print_r($_COOKIE);

「response」で保存した設定情報を含めて確認する方法

　
下記のように、Cookieを保存したあとであれば「response」でも保存した情報を確認することはできます。
　

$this->response = $this->response->withCookie(new Cookie("key","value");
$cookieData = $this->response->getCookie("key");
print_r($cookieData);

$this->response = $this->response->withCookie(new Cookie("key","value");

$cookieData = $this->response->getCookie("key");

print_r($cookieData);

Cookieを削除する方法

　
Cookieを削除する（保存してある Cookieを破棄する）場合は、下記の通り「withExpiredCookie()」を使用します。
　

$this->response = $this->response->withExpiredCookie(new Cookie("key"));

1	$this->response = $this->response->withExpiredCookie(new Cookie("key"));

　
また、すでに解説したように、Cookieを削除する方法として、Cookieを設定の記述で「withValue()」の項目を記述しない、「withExpiry()」の日時を過去日にする、といった方法もあります。
　
　

Cookieの仕様を改めて思い出す

　
Cookieの仕様として当たり前といえば当たり前なのですが、
・1回目の処理で Cookieを保存する
・2回目の処理で Cookieを取り出す
という処理になります。
　
なので、1回目のアクセスで Cookieに値を保存します。
そして、2回目のアクセスで Cookieに保存した値を取り出します。
そのため、Cookieに保存した値を取り出すにはプログラムを 2回実行する必要があります。（1回のアクセスでは、Cookieに保存して、その値を取り出すことは出来ません。）
　
最初、これを忘れていて「あれ？？」とちょっと混乱してしまったこともありましたので、改めて Cookieの仕様を思い出しておくといいかもしれません。
　
　

CakePHP3の Cookieに関する参考記事

　
CakePHP3　Cookbook　クッキー
https://book.cakephp.org/3.0/ja/controllers/components/cookie.html

CakePHP3　Cookbook　リクエストとレスポンスオブジェクト・クッキー
https://book.cakephp.org/3.0/ja/controllers/request-response.html#request-cookies
https://book.cakephp.org/3.0/ja/controllers/request-response.html#id25
　
　

- CakePHP 3.x 4.x CakePHP3

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです！

Message コメントをキャンセル

※入力いただいたコメントは管理者の承認後に掲載されます。

: CakePHP4で定数の設定と呼び出し方法の解説（defineとConfigure）

CakePHP4で定数を設定、使用する方法を解説。定数定義はdefineとConfigureを使用する方法を解説。また、bootstrap.phpに直接記述する方法と別のファイルにする方法を解説。

: CakePHPで同一テーブル内の値を比較する条件でレコードを取得する方法

CakePHPの同一テーブルにある項目の値を比較し条件に合致するレコードを取得する方法を解説。［”項目名”=>”値”]ではなく[”項目名 = 項目名”］と書くところがポイント。

: CakePHP3のメール送信の処理・テンプレート使用・添付ファイル送信も解説

CakePHP3からメールを送信する方法解説。基本的な記述方法を基にして、テンプレートを使う方法、ファイルを添付する方法へと拡張しながら解説。

: CakePHPで Auto Incrementを外すと Duplicate entry ‘0’ for keyのエラーが出るかも

CakePHPでAuto Incrementの設定を変更したときに「Duplicate entry ‘0’ for key」のエラーが出た。原因はModel内で IDを編集する処理の追加を忘れていたからだった。

: cakephp3 カスタムバリデーションを簡易的に実装する方法

CakePHP3の独自のバリデーションをテーブルクラス内に簡単に記述する方法を解説。他のテーブルクラスでは使えないが、記述する量は少なく実装できるため、他で使わない処理を書くのには便利。

: CakePHP 2.x系　Viewでのコメントの記述方法など

CakePHPにおいて View、ctpファイルでコメントを記述する方法を解説。

: CakePHP3でユーザ定義の定数、変数を設定し、読み込む方法解説

CakePHP3で定数や共通で使う変数をまとめて設定し、プログラム内で読み込む方法を、bootstrap.phpに直接記述する方法と定数ファイルを分ける方法の3つの方法で解説。

: CakePHP3のInsert On Duplicate Key Update（upsert）構文を解説・バルク処理も

CakePHP3で Insert … On Duplicate Key Update構文（upsert）を実行する方法を解説。バルク処理の方法も用意されているため大量処理の場合も対応可能。

: CakePHP3のCakeDC/Usersのログイン後のリダイレクトとユーザ権限管理の設定解説

CakeDC謹製Usersプラグインの紹介。ログイン認証後にリダイレクトする先の設定方法についての解説と実運用するために必要なコツを解説。便利な仕組みも仕様の理解があって初めてうまく使いこなせる。