Class: CGI::Session::FileStore

File-based session storage class.

Implements session storage as a flat file of ‘key=value’ values. This storage type only works directly with String values; the user is responsible for converting other types to Strings when storing and from Strings when retrieving.

Methods

close delete new restore update

Public Class methods

new(session, option={})

Create a new FileStore 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 FileStore 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 FileStore file. Defaults to the empty string.
suffix:	the prefix to add to the session id when generating the filename for this session‘s FileStore file. Defaults to the empty string.

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

Public Instance methods

close()

Update and close the session‘s FileStore file.

delete()

Close and delete the session‘s FileStore file.

restore()

Restore session state from the session‘s FileStore file.

Returns the session state as a hash.

update()

Save session state to the session‘s FileStore file.

ruby-doc.org is a service of James Britt and Neurogami, a Ruby application development company in Phoenix, AZ.

Documentation content on ruby-doc.org is provided by remarkable members of the Ruby community.

For more information on the Ruby programming language, visit ruby-lang.org.

Want to help improve Ruby's API docs? See Ruby Documentation Guidelines.