SessionStore
in package
セッション管理処理。
一時データとして扱い、最後にセッションへ反映する感じで動く。 アプリケーション側で明示的に使用しない想定。
Tags
Table of Contents
Constants
- APPLY_CANCEL = 1
- APPLY_NORMAL = 0
- APPLY_RESTART = 2
- APPLY_SHUTDOWN = 3
Properties
- $applyState : int
- セッション適用状態。
- $cookie : CookieStore
- $isChanged : bool
- セッションの値に変更があったか。
- $isStarted : bool
- セッションは開始されているか。
- $options : SessionOptions
- $values : array<string, mixed>
- セッション一時データ。
- $webSecurity : WebSecurity
Methods
- __construct() : mixed
- 生成
- apply() : void
- 一時セッションデータを事前指定された適用種別に応じて反映。
- getOr() : mixed
- セッションデータ取得。
- isChanged() : bool
- セッションは変更されているか。
- isStarted() : bool
- セッションは開始されているか。
- remove() : void
- セッションデータ破棄。
- restart() : void
- セッションIDの再採番。
- set() : void
- セッションデータ設定。
- setApplyState() : int
- セッション適用状態を設定。
- shutdown() : void
- セッションの終了。
- start() : void
- セッション開始。
- tryGet() : bool
- セッションデータ取得。
- applyCore() : void
Constants
APPLY_CANCEL
public
mixed
APPLY_CANCEL
= 1
APPLY_NORMAL
public
mixed
APPLY_NORMAL
= 0
APPLY_RESTART
public
mixed
APPLY_RESTART
= 2
APPLY_SHUTDOWN
public
mixed
APPLY_SHUTDOWN
= 3
Properties
$applyState
セッション適用状態。
private
int
$applyState
= self::APPLY_NORMAL
Tags
$cookie read-only
private
CookieStore
$cookie
$isChanged
セッションの値に変更があったか。
private
bool
$isChanged
= false
$isStarted
セッションは開始されているか。
private
bool
$isStarted
= false
$options read-only
private
SessionOptions
$options
$values
セッション一時データ。
private
array<string, mixed>
$values
= []
$webSecurity
private
WebSecurity
$webSecurity
Methods
__construct()
生成
public
__construct(SessionOptions $options, CookieStore $cookie, WebSecurity $webSecurity) : mixed
Parameters
- $options : SessionOptions
-
セッション設定。
- $cookie : CookieStore
-
Cookie 設定。
- $webSecurity : WebSecurity
apply()
一時セッションデータを事前指定された適用種別に応じて反映。
public
apply() : void
getOr()
セッションデータ取得。
public
getOr(string $key, mixed $fallbackValue) : mixed
Parameters
- $key : string
- $fallbackValue : mixed
Tags
Return values
mixed —取得データ。
isChanged()
セッションは変更されているか。
public
isChanged() : bool
Return values
boolisStarted()
セッションは開始されているか。
public
isStarted() : bool
Return values
boolremove()
セッションデータ破棄。
public
remove(string $key) : void
Parameters
- $key : string
-
対象セッションキー。空白指定ですべて削除。
restart()
セッションIDの再採番。
public
restart() : void
Tags
set()
セッションデータ設定。
public
set(string $key, mixed $value) : void
Parameters
- $key : string
- $value : mixed
Tags
setApplyState()
セッション適用状態を設定。
public
setApplyState(int $state) : int
Parameters
- $state : int
Tags
Return values
intshutdown()
セッションの終了。
public
shutdown() : void
start()
セッション開始。
public
start() : void
Tags
tryGet()
セッションデータ取得。
public
tryGet(string $key, mixed &$result) : bool
Parameters
- $key : string
- $result : mixed
Tags
Return values
bool —取得できたか。
applyCore()
private
applyCore() : void