From 1c057b7237c98d948b08b80c0ac403cda3028dab Mon Sep 17 00:00:00 2001 From: Jamis Buck Date: Sun, 16 Oct 2005 15:42:03 +0000 Subject: Update/clean up AP documentation (rdoc) git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@2649 5ecf4fe2-1ee6-0310-87b1-e25e094e27de --- actionpack/lib/action_controller/base.rb | 4 ++-- actionpack/lib/action_controller/caching.rb | 2 +- actionpack/lib/action_controller/flash.rb | 14 +++++++------- actionpack/lib/action_controller/pagination.rb | 2 +- actionpack/lib/action_controller/request.rb | 16 +++++++++------- actionpack/lib/action_controller/session_management.rb | 2 +- 6 files changed, 21 insertions(+), 19 deletions(-) (limited to 'actionpack/lib/action_controller') diff --git a/actionpack/lib/action_controller/base.rb b/actionpack/lib/action_controller/base.rb index 6b9456cf1f..4cb8c11588 100755 --- a/actionpack/lib/action_controller/base.rb +++ b/actionpack/lib/action_controller/base.rb @@ -46,7 +46,7 @@ module ActionController #:nodoc: # end # # def sign - # Entry.create(@params["entry"]) + # Entry.create(params[:entry]) # redirect_to :action => "index" # end # end @@ -83,7 +83,7 @@ module ActionController #:nodoc: # # def hello_ip # location = request.env["REMOTE_IP"] - # render_text "Hello stranger from #{location}" + # render :text => "Hello stranger from #{location}" # end # # == Parameters diff --git a/actionpack/lib/action_controller/caching.rb b/actionpack/lib/action_controller/caching.rb index 2a9c388250..4c71632c4b 100644 --- a/actionpack/lib/action_controller/caching.rb +++ b/actionpack/lib/action_controller/caching.rb @@ -350,7 +350,7 @@ module ActionController #:nodoc: end end - module ThreadSafety + module ThreadSafety #:nodoc: def read(name, options=nil) #:nodoc: @mutex.synchronize { super } end diff --git a/actionpack/lib/action_controller/flash.rb b/actionpack/lib/action_controller/flash.rb index 90c464dd81..674f73f1a4 100644 --- a/actionpack/lib/action_controller/flash.rb +++ b/actionpack/lib/action_controller/flash.rb @@ -1,14 +1,14 @@ module ActionController #:nodoc: # The flash provides a way to pass temporary objects between actions. Anything you place in the flash will be exposed # to the very next action and then cleared out. This is a great way of doing notices and alerts, such as a create action - # that sets flash["notice"] = "Successfully created" before redirecting to a display action that can then expose + # that sets flash[:notice] = "Successfully created" before redirecting to a display action that can then expose # the flash to its template. Actually, that exposure is automatically done. Example: # # class WeblogController < ActionController::Base # def create # # save post - # flash["notice"] = "Successfully created post" - # redirect_to :action => "display", :params => { "id" => post.id } + # flash[:notice] = "Successfully created post" + # redirect_to :action => "display", :params => { :id => post.id } # end # # def display @@ -17,7 +17,7 @@ module ActionController #:nodoc: # end # # display.rhtml - # <% if @flash["notice"] %>
<%= @flash["notice"] %>
<% end %> + # <% if @flash[:notice] %>
<%= @flash[:notice] %>
<% end %> # # This example just places a string in the flash, but you can put any object in there. And of course, you can put as many # as you like at a time too. Just remember: They'll be gone by the time the next action has been performed. @@ -67,7 +67,7 @@ module ActionController #:nodoc: # Sets a flash that will not be available to the next action, only to the current. # - # flash.now["message"] = "Hello current action" + # 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 ([]=). @@ -82,7 +82,7 @@ module ActionController #:nodoc: # 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 + # flash.keep(:notice) # keeps only the "notice" entry, the rest of the flash is discarded def keep(k=nil) use(k, false) end @@ -90,7 +90,7 @@ module ActionController #:nodoc: # Marks the entire flash or a single flash entry to be discarded by the end of the current action # # flash.keep # keep entire flash available for the next action - # flash.discard('warning') # discard the "warning" entry (it'll still be available for the current action) + # flash.discard(:warning) # discard the "warning" entry (it'll still be available for the current action) def discard(k=nil) use(k) end diff --git a/actionpack/lib/action_controller/pagination.rb b/actionpack/lib/action_controller/pagination.rb index 709b56bfba..9a3584bfab 100644 --- a/actionpack/lib/action_controller/pagination.rb +++ b/actionpack/lib/action_controller/pagination.rb @@ -167,7 +167,7 @@ module ActionController end # Returns a collection of items for the given +model+ and +options[conditions]+, - # ordered by +options[order_by]+, for the current page in the given +paginator+. + # ordered by +options[order]+, for the current page in the given +paginator+. # Override this method to implement a custom finder. def find_collection_for_pagination(model, options, paginator) model.find(:all, :conditions => options[:conditions], diff --git a/actionpack/lib/action_controller/request.rb b/actionpack/lib/action_controller/request.rb index aace415943..a61788237c 100755 --- a/actionpack/lib/action_controller/request.rb +++ b/actionpack/lib/action_controller/request.rb @@ -130,6 +130,8 @@ module ActionController env['RAW_POST_DATA'] end + # Returns the request URI correctly, taking into account the idiosyncracies + # of the various servers. def request_uri if uri = env['REQUEST_URI'] (%r{^\w+\://[^/]+(/.*|$)$} =~ uri) ? $1 : uri # Remove domain, which webrick puts into the request_uri. @@ -216,25 +218,25 @@ module ActionController #-- # Must be implemented in the concrete request #++ - def query_parameters + def query_parameters #:nodoc: end - def request_parameters + def request_parameters #:nodoc: end - def env + def env #:nodoc: end - def host + def host #:nodoc: end - def cookies + def cookies #:nodoc: end - def session + def session #:nodoc: end - def reset_session + def reset_session #:nodoc: end end end diff --git a/actionpack/lib/action_controller/session_management.rb b/actionpack/lib/action_controller/session_management.rb index 6752d66e85..0da594d638 100644 --- a/actionpack/lib/action_controller/session_management.rb +++ b/actionpack/lib/action_controller/session_management.rb @@ -77,7 +77,7 @@ module ActionController #:nodoc: write_inheritable_array("session_options", [options]) end - def cached_session_options + def cached_session_options #:nodoc: @session_options ||= read_inheritable_attribute("session_options") || [] end -- cgit v1.2.3