Ruby on Rails | Screencasts | Download | Documentation | Weblog | Community | Source

Changeset 4277

Show
Ignore:
Timestamp:
04/26/06 18:35:53 (2 years ago)
Author:
marcel
Message:

Documentation for AbstractRequest. Closes #4895. [kevin.clark@gmail.com]

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • trunk/actionpack/CHANGELOG

    r4272 r4277  
    11*SVN* 
     2 
     3* Documentation for AbstractRequest. Closes #4895. [kevin.clark@gmail.com]  
    24 
    35* Refactor various InstanceTag instance method to class methods. Closes #4800. [skaes@web.de] 
  • trunk/actionpack/lib/action_controller/request.rb

    r3989 r4277  
    11module ActionController 
    2   # These methods are available in both the production and test Request objects. 
     2  # Subclassing AbstractRequest makes these methods available to the request objects used in production and testing, 
     3  # CgiRequest and TestRequest 
    34  class AbstractRequest 
    45    cattr_accessor :relative_url_root 
     
    6667    end 
    6768 
     69    # Returns the accepted MIME type for the request 
    6870    def accepts 
    6971      @accepts ||= 
     
    203205    end 
    204206 
    205     def path_parameters=(parameters) 
     207    def path_parameters=(parameters) #:nodoc: 
    206208      @path_parameters = parameters 
    207209      @symbolized_path_parameters = @parameters = nil 
    208210    end 
    209211 
    210     def symbolized_path_parameters 
     212    # The same as <tt>path_parameters</tt> with explicitly symbolized keys  
     213    def symbolized_path_parameters  
    211214      @symbolized_path_parameters ||= path_parameters.symbolize_keys 
    212215    end 
    213216 
     217    # Returns a hash with the parameters used to form the path of the request  
     218    # 
     219    # Example:  
     220    # 
     221    #   {:action => 'my_action', :controller => 'my_controller'} 
    214222    def path_parameters 
    215223      @path_parameters ||= {}