Docs For Class SESSION

static bool close(
)

セッションを閉じるセッションハンドラです。

基本的にはセッションを閉じる際には何もしません。ハンドラは単純に処理成功を表すtrueを返します。

Tags:

return:	処理成功か否か
access:	public

[ Top ]

static bool destroy(
string
$id)

セッションに登録されたデータを全て破棄します。

セッションの明示的な破棄とガーベージコレクションによって収集された際に実行されます。

Tags:

return:	処理成功か否か
access:	public

Parameters:

string

$id

セッションID

[ Top ]

static bool gc(
string
$maxlifetime)

セッションのガーベージコレクションを行います。

PHP標準の動作と同様、セッションの最大生存時間を過ぎたセッションファイルを探し出して削除します。 touch関数がWindows上で利用できない制限から、セッション情報を格納しているディレクトリではなく、セッションファイル本体の最終更新日時を参照します。セッションファイルが存在しないセッション情報を格納するディレクトリと思しきディレクトリも削除されます。

Tags:

return:	処理成功か否か
access:	public

Parameters:

string

$maxlifetime

セッションの最大生存時間

[ Top ]

static string getSessionDir(
[string
$id = false])

セッション情報を格納するディレクトリをフルパス取得します。

任意のセッションIDを指定可能ですが、省略した場合には現在のセッションIDが利用されます。セッションが開かれていない場合にはfalseを返すことに注意してください。

セッションIDはセッションが開かれて最初にセッションデータの読み込みが行われる際に決定されます。従って、新規のセッションを開く際にはセッションが開いているだけのタイミングではディレクトリ名が取得されないことに注意してください。

Tags:

return:	セッションディレクトリ名
access:	public

Parameters:

string

$id

セッションID

[ Top ]

static string getSessionFile(
[string
$id = false])

セッション情報を格納するファイルをフルパスで取得します。セッション情報を格納するファイルには$_SESSIONスーパーグローバル変数の内容がシリアル化されて格納されています。

任意のセッションIDを指定可能ですが、省略した場合には現在のセッションIDが利用されます。セッションが開かれていない場合にはfalseを返すことに注意してください。

セッションIDはセッションが開かれて最初にセッションデータの読み込みが行われる際に決定されます。従って、新規のセッションを開く際にはセッションが開いているだけのタイミングではディレクトリ名が取得されないことに注意してください。

Tags:

return:	セッションファイル名
access:	public

Parameters:

string

$id

セッションID

[ Top ]

static void initialization(
)

セッションハンドラを置き換えてセッション管理をAg:PUREの管理下に置きます。

initializationメソッドはSESSION_HANDLERモジュールがインポートされた際に自動的に実行されます。 initializationメソッドの実行前にセッションが有効になっていた場合にはESessionException例外が発生します。

Tags:

throws:	ESessionException 既にセッションが開かれている
access:	public

[ Top ]

static bool open(
string
$session_save_path, string
$session_name)

セッションを開くセッションハンドラです。

基本的にはセッションを開く際には何もしません。セッション情報を保存する先のパスと、（将来的な対応のため）セッション名のみ記憶し、ハンドラは単純に処理成功を表すtrueを返します。

Tags:

return:	処理成功か否か
access:	public

Parameters:

string	$session_save_path	セッションセーブパス
string	$session_name	セッション名

[ Top ]

static string read(
string
$id)

指定のセッションIDのセッションデータを読み込みます。

初めて生成されたセッションである場合などでセッションデータが見付からない際には、セッション管理領域を初期化します。従って、セッションに値を書き込む動作が発生していなくてもセッション管理領域となるディレクトリと0バイトのセッションファイルが作成されることに注意してください。これらは明示的にセッションが破棄されるか、ガーベージコレクションで収集されるまで削除されません。

PHPのガーベージコレクションは（発生する場合には）readハンドラが呼び出された後に発生します。そのためreadハンドラは既存のセッションファイルから情報を読み出す際にもセッションファイルの最終更新日時を更新します。これにより現在有効なセッションがガーベージコレクションに収集されることを防ぎます。

Tags:

return:	セッションデータ
access:	public

Parameters:

string

$id

セッションID

[ Top ]

static bool write(
string
$id, string
$sess_data)

指定のセッションIDのセッションデータを書き込みます。

Tags:

return:	処理成功か否か
access:	public

Parameters:

string	$id	セッションID
string	$sess_data	セッションデータ

[ Top ]

Class: SESSION_HANDLER

Class Overview

Constants

Methods

Class Details

Class Methods

static method close [line 154]

Tags:

static method destroy [line 375]

Tags:

Parameters:

static method gc [line 391]

Tags:

Parameters:

static method getSessionDir [line 95]

Tags:

Parameters:

static method getSessionFile [line 120]

Tags:

Parameters:

static method initialization [line 66]

Tags:

static method open [line 139]

Tags:

Parameters:

static method read [line 329]

Tags:

Parameters:

static method write [line 352]

Tags:

Parameters:

Class Constants

SESSION_FILE_NAME = 'session.serialize'