Class: ActionController::Flash::FlashHash

Inherits:
Hash
  • Object
show all
Defined in:
lib/action_controller/flash.rb

Instance Method Summary collapse

Constructor Details

#initialize ⇒ FlashHash

:nodoc:



54
55
56
57
 
# File 'lib/action_controller/flash.rb', line 54

def initialize #:nodoc:
  super
  @used = {}
end

Instance Method Details

#[]=(k, v) ⇒ Object

:nodoc:



59
60
61
62
 
# File 'lib/action_controller/flash.rb', line 59

def []=(k, v) #:nodoc:
  keep(k)
  super
end

#discard(k = nil) ⇒ Object

Marks the entire flash or a single flash entry to be discarded by the end of the current action:

flash.discard              # discard the entire flash at the end of the current action
flash.discard(:warning)    # discard only the "warning" entry at the end of the current action



102
103
104
 
# File 'lib/action_controller/flash.rb', line 102

def discard(k = nil)
  use(k)
end

#keep(k = nil) ⇒ Object

Keeps either the entire current flash or a specific flash entry available for the next action:

flash.keep            # keeps the entire flash
flash.keep(:notice)   # keeps only the "notice" entry, the rest of the flash is discarded



94
95
96
 
# File 'lib/action_controller/flash.rb', line 94

def keep(k = nil)
  use(k, false)
end

#now ⇒ Object

Sets a flash that will not be available to the next action, only to the current.

flash.now[:message] = "Hello current action"

This method enables you to use the flash as a central messaging system in your app. When you need to pass an object to the next action, you use the standard flash assign ([]=). When you need to pass an object to the current action, you use now, and your object will vanish when the current action is done.

Entries set via now are accessed the same way as standard entries: flash['my-key'].



86
87
88
 
# File 'lib/action_controller/flash.rb', line 86

def now
  FlashNow.new(self)
end

#replace(h) ⇒ Object

:nodoc:



71
72
73
74
 
# File 'lib/action_controller/flash.rb', line 71

def replace(h) #:nodoc:
  @used = {}
  super
end

#store(session, key = "flash") ⇒ Object 



123
124
125
126
 
# File 'lib/action_controller/flash.rb', line 123

def store(session, key = "flash")
  return if self.empty?
  session[key] = self
end

#sweep ⇒ Object

Mark for removal entries that were kept, and delete unkept ones.

This method is called automatically by filters, so you generally don’t need to care about it.



109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/action_controller/flash.rb', line 109

def sweep #:nodoc:
  keys.each do |k|
    unless @used[k]
      use(k)
    else
      delete(k)
      @used.delete(k)
    end
  end

  # clean up after keys that could have been left over by calling reject! or shift on the flash
  (@used.keys - keys).each{ |k| @used.delete(k) }
end

#update(h) ⇒ Object Also known as: merge!

:nodoc:



64
65
66
67
 
# File 'lib/action_controller/flash.rb', line 64

def update(h) #:nodoc:
  h.keys.each { |k| keep(k) }
  super
end