Class: PHPSession

Inherits:
Object
  • Object
show all
Defined in:
lib/php_session.rb,
lib/php_session/decoder.rb,
lib/php_session/encoder.rb,
lib/php_session/version.rb

Defined Under Namespace

Classes: Decoder, Encoder, Errors

Constant Summary collapse

VERSION = 
"0.3.0"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(session_dir, option = {}) ⇒ PHPSession

Returns a new instance of PHPSession.



9
10
11
12
13
14
15
16
17
 
# File 'lib/php_session.rb', line 9

def initialize(session_dir, option = {})
  default_option = {
    :internal_encoding => Encoding.default_internal,
    :external_encoding => Encoding.default_external,
    :encoding_option => {},
  }
  @option = default_option.merge(option)
  @session_dir = File.expand_path(session_dir)
end

Instance Attribute Details

#data ⇒ Object (readonly)

Returns the value of attribute data.



8
9
10
 
# File 'lib/php_session.rb', line 8

def data
  @data
end

Instance Method Details

#destroy(session_id) ⇒ Object 



27
28
29
30
31
 
# File 'lib/php_session.rb', line 27

def destroy(session_id)
  File.delete(file_path(session_id))
rescue Errno::ENOENT => e
  # file already deleted
end

#load(session_id) ⇒ Object 



19
20
21
22
23
24
25
 
# File 'lib/php_session.rb', line 19

def load(session_id)
  with_lock(file_path(session_id)) do |f|
   # set internal_encoding to nil to avoid encoding conversion
    f.set_encoding(@option[:external_encoding], nil)
    Decoder.decode(f.read, @option[:internal_encoding], @option[:encoding_option]) || {}
  end
end

#save(session_id, data) ⇒ Object 



33
34
35
36
37
38
 
# File 'lib/php_session.rb', line 33

def save(session_id, data)
  with_lock(file_path(session_id)) do |f|
    f.truncate(0)
    f.write(Encoder.encode(data, @option[:external_encoding], @option[:encoding_option]))
  end
end