Ruby 2.3.0 リファレンスマニュアル > ライブラリ一覧 > cgi/sessionライブラリ > CGI::Session::FileStoreクラス

class CGI::Session::FileStore

クラスの継承リスト: CGI::Session::FileStore < Object < Kernel < BasicObject

要約

File を用いたセッション保存先を表すクラスです。

値として文字列のみ保存することができます。 他の型の値を扱うときは、ユーザが責任を持って型変換を行う必要があります。

目次

特異メソッド

new

インスタンスメソッド

close delete restore update

特異メソッド

new(session, option = {}) -> CGI::Session::FileStore[permalink][rdoc]

自身を初期化します。

CGI::Session クラス内部で使用します。 ユーザが明示的に呼び出す必要はありません。

[PARAM] session:

CGI::Session のインスタンスを指定します。

[PARAM] option:

ハッシュを指定します。

以下の文字列をキーとして指定することができます。

tmpdir

セッションデータを作成するディレクトリの名前を指定します。 デフォルトは Dir.tmpdir です。

prefix

セッションデータのファイル名に与えるプレフィックスを指定します。 デフォルトは空文字列です。

suffix

セッションデータのファイル名に与えるサフィックスを指定します。 デフォルトは空文字列です。

[EXCEPTION] CGI::Session::NoSession:

セッションが初期化されていない場合に発生します。

インスタンスメソッド

close -> ()[permalink][rdoc]

セッションの状態をファイルに保存してファイルを閉じます。

delete -> ()[permalink][rdoc]

セッションを削除してファイルも削除します。

restore -> Hash[permalink][rdoc]

セッションの状態をファイルから復元したハッシュを返します。

update -> ()[permalink][rdoc]

セッションの状態をファイルに保存します。