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 コメントをキャンセル

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

: CakePHP 2.3　Search Pluginで検索処理　その３入力エリア一つで複数の項目を同時に検索する方法

CakePHPの検索プラグイン Search Pluginの検索処理の中で入力エリア一つで複数の項目を同時に検索する方法を解説。

: CakePHP3のcontroller内でテンプレート、レイアウトを変更する際の指定方法

CakePHP3でテンプレートファイルやレイアウトファイルをデフォルトのものから別のものに変更したい場合の指定方法を解説。

: CakePHP3のfriendsofcake/searchでブックマークチュートリアルのタグ検索を実装

CakePHP3のCookbookにあるブックマークチュートリアル。ここで紹介されているタグで検索する処理を検索プラグイン「friendsofcake/search」で実現する方法を解説しました。

: CakePHP 2.3　連携先のテーブルの項目で条件抽出する場合

アソシエーション（連携）している先のテーブルの項目で条件抽出する際の考え方と注意点をサンプルソースを用いて説明しています。

: CakePHP3でモデルなしフォームからCSVをアップロードしレコードを更新する方法解説

CakePHP3でCSVファイルをアップロードしレコードを追加、更新する処理の作成方法の解説。モデルとは直接関連しないフォームからCSVファイルをアップロードするため汎用的に使用可能。

: CakePHP3のアソシエーション機能を使い関連レコードをまとめて削除

CakePHP3でレコードを削除する際に関連するレコードをまとめて削除する機能の解説。フレームワークのメリットを存分に発揮し、コマンドを1行追加するだけで実装可能。

: CakePHP3のタイムゾーンを協定世界時UTCから日本標準時間JSTにずれを変更する方法

CakePHP3の標準設定のタイムゾーンは「UTC（協定世界時）」に設定されている。これを日本標準時に変更する方法（app.php、bootstrap.phpの変更方法）の解説。

: CakePHP4のCakeDC/Usersの画面、メール本文テンプレートのカスタマイズ方法解説

CakeDC謹製Usersプラグインの紹介。ユーザ新規登録の流れを紹介しつつ、テンプレートファイル、設定情報ファイルの場所とそれらをカスタマイズする方法を説明します。

: CakePHP4のCSS、JavaScript、画像のブラウザへのキャッシュをコントロールする

CakePHP4、CakePHP3でブラウザにキャッシュさせる設定の解説。CSS、JavaScript、画像をブラウザにキャッシュさせるのか、定期的にリロードする設定にするのかの設定が可能。

: CakePHP3でPHPExcelを使ってエクセルファイルを生成、出力する方法

CakePHP3でPHPExcelを利用してエクセルを編集、出力するサンプルソース＋解説。PHPExcelのインストール方法の解説からファイル保存とダウンロードの方法なども解説。

PREV: CakePHP3でアソシエーション先のカラムでデータをソートして取得したい
NEXT: CakePHP3で環境変数を設定して本番環境と開発環境を分けて処理をする場合

日	月	火	水	木	金	土
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

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

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

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

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

Cookieに値を保存する方法

1項目目、キーの設定

2項目目、withValue()

3項目目、withExpiry()

4項目目、withPath()

5項目目、withDomain()

6項目目、withSecure()

7項目目、withHttpOnly()

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

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

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

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

Cookieを削除する方法

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

CakePHP3の Cookieに関する参考記事

CakePHP3の関連記事

GoogleAdwords

GoogleAdwords

Message コメントをキャンセル

関連記事

CakePHP 2.3　Search Pluginで検索処理　その３入力エリア一つで複数の項目を同時に検索する方法

CakePHP3のcontroller内でテンプレート、レイアウトを変更する際の指定方法

CakePHP3のfriendsofcake/searchでブックマークチュートリアルのタグ検索を実装

CakePHP 2.3　連携先のテーブルの項目で条件抽出する場合

CakePHP3でモデルなしフォームからCSVをアップロードしレコードを更新する方法解説

CakePHP3のアソシエーション機能を使い関連レコードをまとめて削除

CakePHP3のタイムゾーンを協定世界時UTCから日本標準時間JSTにずれを変更する方法

CakePHP4のCakeDC/Usersの画面、メール本文テンプレートのカスタマイズ方法解説

CakePHP4のCSS、JavaScript、画像のブラウザへのキャッシュをコントロールする

CakePHP3でPHPExcelを使ってエクセルファイルを生成、出力する方法

WordPress投稿にPHPを記述するショートコードの使い方add_shortcode

コピーコンテンツ対策.htaccessで直リンク禁止しリダイレクトで対応

評価点投票プラグイン10個を比較！WordPressで口コミサイトを構築

BackWPupでバックアップ・リストア（復元）の具体的手順

コンパクトキーボード・KEK-EA9AU・FKB1420の魅力