Cookie ヘルパー¶
クッキーヘルパーのファイルは、クッキーを処理するのに役立つ関数で 構成されています。
利用できる機能¶
次の関数が利用できます:
パラメータ: - $name (mixed) – クッキー名 又は この関数で利用可能なパラメータの全ての連想配列
- $value (string) – クッキーの値
- $expire (int) – 有効期限までの秒数
- $domain (string) – クッキーのドメイン(通例: .yourdomain.com)
- $path (string) – クッキーのパス
- $prefix (string) – クッキー名の接頭辞
- $secure (bool) – HTTPS でのみクッキーを送信するかどうか
- $httponly (bool) – JavaScript からクッキーを隠すかどうか
返り値の型: void
このヘルパー関数はブラウザのクッキーをセットするのに便利な 関数です。 この関数は CI_Input::set_cookie() のエイリアスですので、 詳細は 入力およびセキュリティクラス を参照してください。
パラメータ: - $index (string) – クッキー名
- $xss_clean (bool) – 返却される値に XSS フィルタを適用するかどうか
返り値: クッキーの値又は見つからない場合は NULL
返り値の型: mixed
このヘルパー関数はブラウザのクッキーをセットするのに便利な 関数です。 この関数は application/config/config.php ファイルに $config['cookie_prefix'] を指定した場合に接頭辞が付与される事を除けば CI_Input::cookie() とほとんど一緒です。 詳細は 入力およびセキュリティクラス を 参照してください。
パラメータ: - $name (string) – クッキー名
- $domain (string) – クッキーのドメイン(通例: .yourdomain.com)
- $path (string) – クッキーのパス
- $prefix (string) – クッキー名の接頭辞
返り値の型: void
クッキーを削除できます。 カスタムパスやその他の値は必要なく、次のように クッキー名のみ指定してください。
delete_cookie('name');
この関数は、値や有効期限のパラメータがない以外は、 set_cookie() と 同じものです。 第1引数に配列で渡すか、 個別パラメータで値を渡すことができます。
delete_cookie($name, $domain, $path, $prefix);