kotovalexarian-likes-github/rails--rails
1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
Code Releases Activity

Added documentation for the ActionController::MimeResponds::Collector class.

Browse source
This commit is contained in:
Mark Thomson 2012-03-13 02:36:59 -05:00
parent 64cd57aba9
commit 4cb71eaf46
1 changed files with 24 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
actionpack/lib/action_controller/metal/mime_responds.rb
View file

@ -279,7 +279,30 @@ module ActionController #:nodoc:
end
end
class Collector #:nodoc:
# A container of responses available for requests with different mime-types
# sent to the current controller action.
#
# The public controller methods +respond_with+ and +respond_to+ may be called
# with a block that is used to define responses to different mime-types, e.g.
# for +respond_to+ :
#
# respond_to do |format|
# format.html
# format.xml { render :xml => @people.to_xml }
# end
#
# In this usage, the argument passed to the block (+format+ above) is an
# instance of the ActionController::MimeResponds::Collector class. This
# object serves as a container in which available responses can be stored by
# calling any of the dynamically generated, mime-type-specific methods such
# as +html+, +xml+ etc on the Collector. Each response is represented by a
# corresponding block if present.
#
# A subsequent call to #negotiate_format(request) will enable the Collector
# to determine which specific mime-type it should respond with for the current
# request, with this response then being accessible by calling #response.
#
class Collector
include AbstractController::Collector
attr_accessor :order, :format