CookieStore
in package
Cookie 管理処理。
セッション側と違い、都度取得する感じ。
アプリケーション側で明示的に使用しない想定。
Table of Contents
Properties
- $options : CookieOptions
- $special : SpecialStore
- $isChanged : bool
- クッキーの値に変更があったか。
- $removes : array<string|int, string>
- 削除データ(キー項目)。
- $values : array<string, LocalCookieData>
- cookie 一時設定データ。
Methods
- __construct() : mixed
- 生成
- apply() : void
- 一時クッキーデータをセッションに反映。
- getOr() : string
- クッキーデータ取得。
- isChanged() : bool
- クッキーは変更されているか。
- remove() : void
- クッキーデータ破棄。
- set() : void
- クッキーデータ設定。
- tryGet() : bool
- クッキーデータ取得。
Properties
$options read-only
public
CookieOptions
$options
$special read-only
protected
SpecialStore
$special
$isChanged
クッキーの値に変更があったか。
private
bool
$isChanged
= false
$removes
削除データ(キー項目)。
private
array<string|int, string>
$removes
= []
Tags
$values
cookie 一時設定データ。
private
array<string, LocalCookieData>
$values
= []
Methods
__construct()
生成
public
__construct(SpecialStore $special, CookieOptions $options) : mixed
Parameters
- $special : SpecialStore
- $options : CookieOptions
apply()
一時クッキーデータをセッションに反映。
public
apply() : void
getOr()
クッキーデータ取得。
public
getOr(string $key, string $fallbackValue) : string
Parameters
- $key : string
- $fallbackValue : string
Return values
string —取得データ。
isChanged()
クッキーは変更されているか。
public
isChanged() : bool
Return values
boolremove()
クッキーデータ破棄。
public
remove(string $key) : void
Parameters
- $key : string
-
キー。空白指定ですべて削除。
set()
クッキーデータ設定。
public
set(string $key, string $value[, CookieOptions|null $options = null ]) : void
Parameters
- $key : string
- $value : string
- $options : CookieOptions|null = null
-
nullの場合コンストラクタで渡された設定値が使用される
tryGet()
クッキーデータ取得。
public
tryGet(string $key, string &$result) : bool
Parameters
- $key : string
- $result : string
Return values
bool —取得できたか。