class ActionDispatch::Flash::FlashHash
Public Instance Methods
Source
# File lib/action_dispatch/middleware/flash.rb, line 169 def [](k) @flashes[k.to_s] end
Source
# File lib/action_dispatch/middleware/flash.rb, line 163 def []=(k, v) k = k.to_s @discard.delete k @flashes[k] = v end
Source
# File lib/action_dispatch/middleware/flash.rb, line 280 def alert self[:alert] end
Convenience accessor for flash[:alert]
.
Source
# File lib/action_dispatch/middleware/flash.rb, line 285 def alert=(message) self[:alert] = message end
Convenience accessor for flash[:alert]=
.
Source
# File lib/action_dispatch/middleware/flash.rb, line 204 def clear @discard.clear @flashes.clear end
Source
# File lib/action_dispatch/middleware/flash.rb, line 189 def delete(key) key = key.to_s @discard.delete key @flashes.delete key self end
Immediately deletes the single flash entry. Use this method when you want remove the message within the current action. See also discard
.
Source
# File lib/action_dispatch/middleware/flash.rb, line 264 def discard(k = nil) k = k.to_s if k @discard.merge Array(k || keys) k ? self[k] : self end
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
Use this method when you want to display the message in the current action but not in the next one. See also delete
.
Source
# File lib/action_dispatch/middleware/flash.rb, line 209 def each(&block) @flashes.each(&block) end
Source
# File lib/action_dispatch/middleware/flash.rb, line 200 def empty? @flashes.empty? end
Source
# File lib/action_dispatch/middleware/flash.rb, line 155 def initialize_copy(other) if other.now_is_loaded? @now = other.now.dup @now.flash = self end super end
Source
# File lib/action_dispatch/middleware/flash.rb, line 250 def keep(k = nil) k = k.to_s if k @discard.subtract Array(k || keys) k ? self[k] : self end
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
Source
# File lib/action_dispatch/middleware/flash.rb, line 183 def key?(name) @flashes.key? name.to_s end
Source
# File lib/action_dispatch/middleware/flash.rb, line 290 def notice self[:notice] end
Convenience accessor for flash[:notice]
.
Source
# File lib/action_dispatch/middleware/flash.rb, line 295 def notice=(message) self[:notice] = message end
Convenience accessor for flash[:notice]=
.
Source
# File lib/action_dispatch/middleware/flash.rb, line 241 def now @now ||= FlashNow.new(self) end
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']
.
Also, brings two convenience accessors:
flash.now.alert = "Beware now!" # Equivalent to flash.now[:alert] = "Beware now!" flash.now.notice = "Good luck now!" # Equivalent to flash.now[:notice] = "Good luck now!"
Source
# File lib/action_dispatch/middleware/flash.rb, line 196 def to_hash @flashes.dup end
Protected Instance Methods
Source
# File lib/action_dispatch/middleware/flash.rb, line 300 def now_is_loaded? @now end
Private Instance Methods
Source
# File lib/action_dispatch/middleware/flash.rb, line 305 def stringify_array(array) # :doc: array.map do |item| item.kind_of?(Symbol) ? item.to_s : item end end