Skip to Content Skip to Search

class ActionDispatch::Flash::FlashHash

Inherits From

Public instance methods

[](k)

Permalink
Source code GitHub 
# File actionpack/lib/action_dispatch/middleware/flash.rb, line 162
def [](k)
  @flashes[k.to_s]
end

[]=(k, v)

Permalink
Source code GitHub 
# File actionpack/lib/action_dispatch/middleware/flash.rb, line 156
def []=(k, v)
  k = k.to_s
  @discard.delete k
  @flashes[k] = v
end

alert()

Permalink

Convenience accessor for flash[:alert].

Source code GitHub 
# File actionpack/lib/action_dispatch/middleware/flash.rb, line 268
def alert
  self[:alert]
end

alert=(message)

Permalink

Convenience accessor for flash[:alert]=.

Source code GitHub 
# File actionpack/lib/action_dispatch/middleware/flash.rb, line 273
def alert=(message)
  self[:alert] = message
end

clear()

Permalink
Source code GitHub 
# File actionpack/lib/action_dispatch/middleware/flash.rb, line 197
def clear
  @discard.clear
  @flashes.clear
end

delete(key)

Permalink

Immediately deletes the single flash entry. Use this method when you want remove the message within the current action. See also discard.

Source code GitHub 
# File actionpack/lib/action_dispatch/middleware/flash.rb, line 182
def delete(key)
  key = key.to_s
  @discard.delete key
  @flashes.delete key
  self
end

discard(k = nil)

Permalink

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 code GitHub 
# File actionpack/lib/action_dispatch/middleware/flash.rb, line 253
def discard(k = nil)
  k = k.to_s if k
  @discard.merge Array(k || keys)
  k ? self[k] : self
end

each(&block)

Permalink
Source code GitHub 
# File actionpack/lib/action_dispatch/middleware/flash.rb, line 202
def each(&block)
  @flashes.each(&block)
end

empty?()

Permalink
Source code GitHub 
# File actionpack/lib/action_dispatch/middleware/flash.rb, line 193
def empty?
  @flashes.empty?
end

initialize_copy(other)

Permalink
Source code GitHub 
# File actionpack/lib/action_dispatch/middleware/flash.rb, line 148
def initialize_copy(other)
  if other.now_is_loaded?
    @now = other.now.dup
    @now.flash = self
  end
  super
end

keep(k = nil)

Permalink

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 code GitHub 
# File actionpack/lib/action_dispatch/middleware/flash.rb, line 240
def keep(k = nil)
  k = k.to_s if k
  @discard.subtract Array(k || keys)
  k ? self[k] : self
end

key?(name)

Permalink
Source code GitHub 
# File actionpack/lib/action_dispatch/middleware/flash.rb, line 176
def key?(name)
  @flashes.key? name.to_s
end

keys()

Permalink
Source code GitHub 
# File actionpack/lib/action_dispatch/middleware/flash.rb, line 172
def keys
  @flashes.keys
end

notice()

Permalink

Convenience accessor for flash[:notice].

Source code GitHub 
# File actionpack/lib/action_dispatch/middleware/flash.rb, line 278
def notice
  self[:notice]
end

notice=(message)

Permalink

Convenience accessor for flash[:notice]=.

Source code GitHub 
# File actionpack/lib/action_dispatch/middleware/flash.rb, line 283
def notice=(message)
  self[:notice] = message
end

now()

Permalink

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 code GitHub 
# File actionpack/lib/action_dispatch/middleware/flash.rb, line 232
def now
  @now ||= FlashNow.new(self)
end

to_hash()

Permalink
Source code GitHub 
# File actionpack/lib/action_dispatch/middleware/flash.rb, line 189
def to_hash
  @flashes.dup
end

Protected instance methods

now_is_loaded?()

Permalink
Source code GitHub 
# File actionpack/lib/action_dispatch/middleware/flash.rb, line 288
def now_is_loaded?
  @now
end

Private instance methods

stringify_array(array)

Permalink
Source code GitHub 
# File actionpack/lib/action_dispatch/middleware/flash.rb, line 293
def stringify_array(array) # :doc:
  array.map do |item|
    item.kind_of?(Symbol) ? item.to_s : item
  end
end

Definition files