aboutsummaryrefslogtreecommitdiffstats
path: root/actionview
diff options
context:
space:
mode:
authorNithin Bekal <nithinbekal@gmail.com>2015-02-17 18:23:16 +0530
committerNithin Bekal <nithinbekal@gmail.com>2015-02-17 18:25:59 +0530
commit3e66017b55fe2a94d3dbd50d5de8422f5724be4a (patch)
tree5f33d991f10c3615e320883dd7e4af46d9abd42a /actionview
parentde537263a70469248090b5c52686760f92386a9b (diff)
downloadrails-3e66017b55fe2a94d3dbd50d5de8422f5724be4a.tar.gz
rails-3e66017b55fe2a94d3dbd50d5de8422f5724be4a.tar.bz2
rails-3e66017b55fe2a94d3dbd50d5de8422f5724be4a.zip
Add documentation for local_assigns [ci skip]
Diffstat (limited to 'actionview')
-rw-r--r--actionview/lib/action_view/base.rb8
1 files changed, 8 insertions, 0 deletions
diff --git a/actionview/lib/action_view/base.rb b/actionview/lib/action_view/base.rb
index 1feafc1094..43124bb904 100644
--- a/actionview/lib/action_view/base.rb
+++ b/actionview/lib/action_view/base.rb
@@ -70,6 +70,14 @@ module ActionView #:nodoc:
# Headline: <%= headline %>
# First name: <%= person.first_name %>
#
+ # The local variables passed to sub templates can be accessed as a hash using the <tt>local_assigns</tt> hash. This lets you access the
+ # variables as:
+ #
+ # Headline: <%= local_assigns[:headline] %>
+ #
+ # This is useful in cases where you aren't sure if the local variable has been assigned. Alternately, you could also use
+ # <tt>defined? headline</tt> to first check if the variable has been assigned before using it.
+ #
# === Template caching
#
# By default, Rails will compile each template to a method in order to render it. When you alter a template,