123456789_123456789_123456789_123456789_123456789_

Class: ActionDispatch::Flash::FlashHash

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Instance Chain:
self, ::Enumerable
Inherits: Object
Defined in: actionpack/lib/action_dispatch/middleware/flash.rb

Instance Attribute Summary

::Enumerable - Included

#many?

Returns true if the enumerable has more than 1 element.

Instance Method Summary

::Enumerable - Included

#exclude?

The negative of the Enumerable#include?.
#index_by

Convert an enumerable to a hash.
#sum

Calculates a sum from the elements.

Instance Attribute Details

#alert (rw)

Convenience accessor for flash[:alert].

[ GitHub ] 

  


# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 224



def alert
  self[:alert]
end


  








  

    #alert=(message)   (rw)
  



  

    

Convenience accessor for flash[:alert]=.


  



  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 229



def alert=(message)
  self[:alert] = message
end


  








  

    #empty?  ⇒ Boolean  (readonly)
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 152



def empty?
  @flashes.empty?
end


  








  

    #notice   (rw)
  



  

    

Convenience accessor for flash[:notice].


  



  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 234



def notice
  self[:notice]
end


  








  

    #notice=(message)   (rw)
  



  

    

Convenience accessor for flash[:notice]=.


  



  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 239



def notice=(message)
  self[:notice] = message
end


  







Instance Method Details



  

    #[](k)  
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 123



def [](k)
  @flashes[k.to_s]
end


  








  

    #[]=(k, v)  
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 117



def []=(k, v)
  k = k.to_s
  @discard.delete k
  @flashes[k] = v
end


  








  

    #clear  
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 156



def clear
  @discard.clear
  @flashes.clear
end


  








  

    #delete(key)  
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 141



def delete(key)
  key = key.to_s
  @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


  



  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 209



def discard(k = nil)
  k = k.to_s if k
  @discard.merge Array(k || keys)
  k ? self[k] : self
end


  








  

    #each(&block)  
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 161



def each(&block)
  @flashes.each(&block)
end


  








  

    #initialize_copy(other)  
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 109



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


  



  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 199



def keep(k = nil)
  k = k.to_s if k
  @discard.subtract Array(k || keys)
  k ? self[k] : self
end


  








  

    #key?(name)  ⇒ Boolean 
  



  

    
  





  


  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 137



def key?(name)
  @flashes.key? name.to_s
end


  








  

    #keys  
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 133



def keys
  @flashes.keys
end


  








  

    #merge!(h)  
  



  

    

Alias for #update.


  



  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 165



alias :merge! :update


  








  

    #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!"


  



  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 191



def now
  @now ||= FlashNow.new(self)
end


  








  

    #to_hash  
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 148



def to_hash
  @flashes.dup
end