Docs For Class Ethna

Ethna_Session

Description

セッションクラス

author: Masaki Fujimoto <fujimoto@php.net>
access: public

Located in /class/Ethna_Session.php (line 20)

Method Summary

Ethna_Session Ethna_Session (string $appid, string $save_dir, $logger)

bool destroy ()

mixed get (string $name)

bool isAnonymous ()

bool isStart ([string $anonymous = false])

bool isValid ()

bool regenerateId ([ $lifetime = 0], [ $anonymous = false])

bool remove (string $name)

void restore ()

bool set (string $name, string $value)

bool start ([int $lifetime = 0], [ $anonymous = false])

Methods

Constructor Ethna_Session (line 50)

Ethna_Sessionクラスのコンストラクタ

access: public

Ethna_Session Ethna_Session (string $appid, string $save_dir, $logger)

string $appid: アプリケーションID(セッション名として使用)
string $save_dir: セッションデータを保存するディレクトリ
$logger

destroy (line 174)

セッションを破棄する

return: true:正常終了 false:エラー
access: public

bool destroy ()

get (line 220)

セッション値へのアクセサ(R)

return: 取得した値(null:セッションが開始されていない)
access: public

mixed get (string $name)

string $name: キー

isAnonymous (line 296)

匿名セッションかどうかを返す

return: true:匿名セッション false:非匿名セッション/セッション開始されていない
access: public

bool isAnonymous ()

isStart (line 277)

セッションが開始されているかどうかを返す

return: true:開始済み false:開始されていない
access: public

bool isStart ([string $anonymous = false])

string $anonymous: 匿名セッションを「開始」とみなすかどうか(default: false)

isValid (line 112)

セッションの正当性チェック

return: true:正当なセッション false:不当なセッション
access: public

bool isValid ()

regenerateId (line 193)

セッションIDを再生成する

return: true:正常終了 false:エラー
access: public

bool regenerateId ([ $lifetime = 0], [ $anonymous = false])

$lifetime
$anonymous

remove (line 259)

セッションの値を破棄する

return: true:正常終了 false:エラー(セッションが開始されていない)
access: public

bool remove (string $name)

string $name: キー

restore (line 84)

セッションを復帰する

access: public

void restore ()

set (line 240)

セッション値へのアクセサ(W)

return: true:正常終了 false:エラー(セッションが開始されていない)
access: public

bool set (string $name, string $value)

string $name: キー
string $value: 値

start (line 142)

セッションを開始する

return: true:正常終了 false:エラー
access: public

bool start ([int $lifetime = 0], [ $anonymous = false])

int $lifetime: セッション有効期間(秒単位, 0ならセッションクッキー)
$anonymous

Documentation generated on Fri, 11 Nov 2011 04:00:52 +0900 by phpDocumentor 1.4.3