Class: ActionController::Flash::FlashHash
- Defined in:
- lib/action_controller/flash.rb
Instance Method Summary collapse
-
#[]=(k, v) ⇒ Object
:nodoc:.
-
#discard(k = nil) ⇒ Object
Marks the entire flash or a single flash entry to be discarded by the end of the current action:.
-
#initialize ⇒ FlashHash
constructor
:nodoc:.
-
#keep(k = nil) ⇒ Object
Keeps either the entire current flash or a specific flash entry available for the next action:.
-
#now ⇒ Object
Sets a flash that will not be available to the next action, only to the current.
-
#replace(h) ⇒ Object
:nodoc:.
-
#sweep ⇒ Object
Mark for removal entries that were kept, and delete unkept ones.
-
#update(h) ⇒ Object
(also: #merge!)
:nodoc:.
Constructor Details
#initialize ⇒ FlashHash
:nodoc:
53 54 55 56 |
# File 'lib/action_controller/flash.rb', line 53 def initialize #:nodoc: super @used = {} end |
Instance Method Details
#[]=(k, v) ⇒ Object
:nodoc:
58 59 60 61 |
# File 'lib/action_controller/flash.rb', line 58 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
101 102 103 |
# File 'lib/action_controller/flash.rb', line 101 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
93 94 95 |
# File 'lib/action_controller/flash.rb', line 93 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']
.
85 86 87 |
# File 'lib/action_controller/flash.rb', line 85 def now FlashNow.new(self) end |
#replace(h) ⇒ Object
:nodoc:
70 71 72 73 |
# File 'lib/action_controller/flash.rb', line 70 def replace(h) #:nodoc: @used = {} super 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.
108 109 110 111 112 113 114 115 116 117 118 119 120 |
# File 'lib/action_controller/flash.rb', line 108 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:
63 64 65 66 |
# File 'lib/action_controller/flash.rb', line 63 def update(h) #:nodoc: h.keys.each { |k| keep(k) } super end |