Methods
#
A
C
D
E
F
I
K
N
T
Included Modules
Class Public methods
from_session_value(value)
# File actionpack/lib/action_dispatch/middleware/flash.rb, line 76
def self.from_session_value(value)
  flash = case value
          when FlashHash # Rails 3.1, 3.2
            new(value.instance_variable_get(:@flashes), value.instance_variable_get(:@used))
          when Hash # Rails 4.0
            new(value['flashes'], value['discard'])
          else
            new
          end

  flash.tap(&:sweep)
end
Instance Public methods
[](k)
# File actionpack/lib/action_dispatch/middleware/flash.rb, line 113
def [](k)
  @flashes[k]
end
[]=(k, v)
# File actionpack/lib/action_dispatch/middleware/flash.rb, line 108
def []=(k, v)
  @discard.delete k
  @flashes[k] = v
end
alert()

Convenience accessor for flash[:alert].

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

Convenience accessor for flash[:alert]=.

# File actionpack/lib/action_dispatch/middleware/flash.rb, line 216
def alert=(message)
  self[:alert] = message
end
clear()
# File actionpack/lib/action_dispatch/middleware/flash.rb, line 145
def clear
  @discard.clear
  @flashes.clear
end
delete(key)
# File actionpack/lib/action_dispatch/middleware/flash.rb, line 131
def delete(key)
  @discard.delete key
  @flashes.delete key
  self
end
discard(k = nil)

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
# File actionpack/lib/action_dispatch/middleware/flash.rb, line 197
def discard(k = nil)
  @discard.merge Array(k || keys)
  k ? self[k] : self
end
each(&block)
# File actionpack/lib/action_dispatch/middleware/flash.rb, line 150
def each(&block)
  @flashes.each(&block)
end
empty?()
# File actionpack/lib/action_dispatch/middleware/flash.rb, line 141
def empty?
  @flashes.empty?
end
initialize_copy(other)
# File actionpack/lib/action_dispatch/middleware/flash.rb, line 100
def initialize_copy(other)
  if other.now_is_loaded?
    @now = other.now.dup
    @now.flash = self
  end
  super
end
keep(k = nil)

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
# File actionpack/lib/action_dispatch/middleware/flash.rb, line 188
def keep(k = nil)
  @discard.subtract Array(k || keys)
  k ? self[k] : self
end
key?(name)
# File actionpack/lib/action_dispatch/middleware/flash.rb, line 127
def key?(name)
  @flashes.key? name.to_s
end
keys()
# File actionpack/lib/action_dispatch/middleware/flash.rb, line 123
def keys
  @flashes.keys
end
notice()

Convenience accessor for flash[:notice].

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

Convenience accessor for flash[:notice]=.

# File actionpack/lib/action_dispatch/middleware/flash.rb, line 226
def notice=(message)
  self[:notice] = message
end
now()

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!"
# File actionpack/lib/action_dispatch/middleware/flash.rb, line 180
def now
  @now ||= FlashNow.new(self)
end
to_hash()
# File actionpack/lib/action_dispatch/middleware/flash.rb, line 137
def to_hash
  @flashes.dup
end
to_session_value()
# File actionpack/lib/action_dispatch/middleware/flash.rb, line 89
def to_session_value
  return nil if empty?
  {'discard' => @discard.to_a, 'flashes' => @flashes}
end
Instance Protected methods
now_is_loaded?()
# File actionpack/lib/action_dispatch/middleware/flash.rb, line 231
def now_is_loaded?
  @now
end