# CGI::Session::PStore (Class)

In: | cgi/session/pstore.rb
Parent: | Object

PStore-based session storage class.

This builds upon the top-level PStore class provided by the library file pstore.rb. Session data is marshalled and stored in a file. File locking and transaction services are provided.

## Methods

close delete new restore update

## Public Class methods

new(session, option={})

Create a new CGI::Session::PStore instance

This constructor is used internally by CGI::Session. The user does not generally need to call it directly.

`session` is the session for which this instance is being created. The session id must only contain alphanumeric characters; automatically generated session ids observe this requirement.

`option` is a hash of options for the initialiser. The following options are recognised:

tmpdir: | the directory to use for storing the PStore file. Defaults to Dir::tmpdir (generally "/tmp" on Unix systems).
prefix: | the prefix to add to the session id when generating the filename for this session’s PStore file. Defaults to the empty string.

This session’s PStore file will be created if it does not exist, or opened if it does.

[Source]

    # File cgi/session/pstore.rb, line 60
          def initialize session, option={}
            dir = option['tmpdir'] || ENV['TMP'] || '/tmp'
            prefix = option['prefix'] || ''
            id = session.session_id
            unless check_id(id)
              raise ArgumentError, "session_id `%s' is invalid" % id
            end
            path = dir+"/"+prefix+id
            path.untaint
            unless File::exist? path
              @hash = {}
            end
            @p = ::PStore.new(path)
          end

## Public Instance methods

restore()

Restore session state from the session’s PStore file.

Returns the session state as a hash.

[Source]

    # File cgi/session/pstore.rb, line 78
          def restore
            unless @hash
              @p.transaction do
                begin
                  @hash = @p['hash']
                rescue
                  @hash = {}
                end
              end
            end
            @hash
          end

update()

Save session state to the session’s PStore file.

[Source]

    # File cgi/session/pstore.rb, line 92
          def update
            @p.transaction do
                @p['hash'] = @hash
            end
          end

close()

Update and close the session’s PStore file.

[Source]

    # File cgi/session/pstore.rb, line 99
          def close
            update
          end

delete()

Close and delete the session’s PStore file.

[Source]

    # File cgi/session/pstore.rb, line 104
          def delete
            path = @p.path
            File::unlink path
          end

[Validate]