Current File : //opt/alt/ruby18/share/ri/1.8/system/CGI/Session/FileStore/new-c.yaml
--- !ruby/object:RI::MethodDescription
aliases: []
block_params:
comment:
- !ruby/struct:SM::Flow::P
body: Create a new FileStore instance.
- !ruby/struct:SM::Flow::P
body: This constructor is used internally by CGI::Session. The user does not generally need to call it directly.
- !ruby/struct:SM::Flow::P
body: <tt>session</tt> 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.
- !ruby/struct:SM::Flow::P
body: "<tt>option</tt> is a hash of options for the initializer. The following options are recognised:"
- !ruby/object:SM::Flow::LIST
contents:
- !ruby/struct:SM::Flow::LI
label: "tmpdir:"
body: the directory to use for storing the FileStore file. Defaults to Dir::tmpdir (generally "/tmp" on Unix systems).
- !ruby/struct:SM::Flow::LI
label: "prefix:"
body: the prefix to add to the session id when generating the filename for this session's FileStore file. Defaults to the empty string.
- !ruby/struct:SM::Flow::LI
label: "suffix:"
body: the prefix to add to the session id when generating the filename for this session's FileStore file. Defaults to the empty string.
type: :NOTE
- !ruby/struct:SM::Flow::P
body: This session's FileStore file will be created if it does not exist, or opened if it does.
full_name: CGI::Session::FileStore::new
is_singleton: true
name: new
params: (session, option={})
visibility: public