Class | ActionView::Base |
In: |
vendor/rails/actionpack/lib/action_view/base.rb
vendor/rails/actionpack/lib/action_view/helpers/active_record_helper.rb |
Parent: | Object |
Action View templates can be written in two ways. If the template file has a +.rhtml+ extension then it uses a mixture of ERb (included in Ruby) and HTML. If the template file has a +.rxml+ extension then Jim Weirich’s Builder::XmlMarkup library is used.
You trigger ERb by using embeddings such as <% %> and <%= %>. The difference is whether you want output or not. Consider the following loop for names:
<b>Names of all the people</b> <% for person in @people %> Name: <%= person.name %><br/> <% end %>
The loop is setup in regular embedding tags (<% %>) and the name is written using the output embedding tag (<%= %>). Note that this is not just a usage suggestion. Regular output functions like print or puts won’t work with ERb templates. So this would be wrong:
Hi, Mr. <% puts "Frodo" %>
(If you absolutely must write from within a function, you can use the TextHelper#concat)
Using sub templates allows you to sidestep tedious replication and extract common display structures in shared templates. The classic example is the use of a header and footer (even though the Action Pack-way would be to use Layouts):
<%= render "shared/header" %> Something really specific and terrific <%= render "shared/footer" %>
As you see, we use the output embeddings for the render methods. The render call itself will just return a string holding the result of the rendering. The output embedding writes it to the current template.
But you don’t have to restrict yourself to static includes. Templates can share variables amongst themselves by using instance variables defined in using the regular embedding tags. Like this:
<% @page_title = "A Wonderful Hello" %> <%= render "shared/header" %>
Now the header can pick up on the @page_title variable and use it for outputting a title tag:
<title><%= @page_title %></title>
You can pass local variables to sub templates by using a hash with the variable names as keys and the objects as values:
<%= render "shared/header", { "headline" => "Welcome", "person" => person } %>
These can now be accessed in shared/header with:
Headline: <%= headline %> First name: <%= person.first_name %>
The parsing of ERb templates are cached by default, but the reading of them are not. This means that the application by default will reflect changes to the templates immediatly. If you’d like to sacrifice that immediacy for the speed gain given by also caching the loading of templates (reading from the file system), you can turn that on with ActionView::Base.cache_template_loading = true.
Builder templates are a more programmatic alternative to ERb. They are especially useful for generating XML content. An XmlMarkup object named xml is automatically made available to templates with a +.rxml+ extension.
Here are some basic examples:
xml.em("emphasized") # => <em>emphasized</em> xml.em { xml.b("emp & bold") } # => <em><b>emph & bold</b></em> xml.a("A Link", "href"=>"http://onestepback.org") # => <a href="http://onestepback.org">A Link</a> xm.target("name"=>"compile", "option"=>"fast") # => <target option="fast" name="compile"\> # NOTE: order of attributes is not specified.
Any method with a block will be treated as an XML markup tag with nested markup in the block. For example, the following:
xml.div { xml.h1(@person.name) xml.p(@person.bio) }
would produce something like:
<div> <h1>David Heinemeier Hansson</h1> <p>A product of Danish Design during the Winter of '79...</p> </div>
A full-length RSS example actually used on Basecamp:
xml.rss("version" => "2.0", "xmlns:dc" => "http://purl.org/dc/elements/1.1/") do xml.channel do xml.title(@feed_title) xml.link(@url) xml.description "Basecamp: Recent items" xml.language "en-us" xml.ttl "40" for item in @recent_items xml.item do xml.title(item_title(item)) xml.description(item_description(item)) if item_description(item) xml.pubDate(item_pubDate(item)) xml.guid(@person.firm.account.url + @recent_items.url(item)) xml.link(@person.firm.account.url + @recent_items.url(item)) xml.tag!("dc:creator", item.author_name) if item_has_creator?(item) end end end end
More builder documentation can be found at builder.rubyforge.org.
assigns | [RW] | |
base_path | [RW] | |
controller | [RW] | |
first_render | [R] | |
flash | [R] | |
headers | [R] | |
logger | [R] | |
params | [R] | |
response | [R] | |
session | [R] | |
template_extension | [RW] |
# File vendor/rails/actionpack/lib/action_view/base.rb, line 147 147: def self.register_template_handler(extension, klass) 148: @@template_handlers[extension] = klass 149: end
Renders the template present at template_path (relative to the template_root). The hash in local_assigns is made available as local variables.
# File vendor/rails/actionpack/lib/action_view/base.rb, line 186 186: def render(options = {}, old_local_assigns = {}) 187: if options.is_a?(String) 188: render_file(options, true, old_local_assigns) 189: elsif options.is_a?(Hash) 190: options[:locals] ||= {} 191: options[:use_full_path] = options[:use_full_path].nil? ? true : options[:use_full_path] 192: 193: if options[:file] 194: render_file(options[:file], options[:use_full_path], options[:locals]) 195: elsif options[:partial] && options[:collection] 196: render_partial_collection(options[:partial], options[:collection], options[:spacer_template], options[:locals]) 197: elsif options[:partial] 198: render_partial(options[:partial], options[:object], options[:locals]) 199: elsif options[:inline] 200: render_template(options[:type] || :rhtml, options[:inline], options[:locals] || {}) 201: end 202: end 203: end
Renders the template present at template_path. If use_full_path is set to true, it’s relative to the template_root, otherwise it’s absolute. The hash in local_assigns is made available as local variables.
# File vendor/rails/actionpack/lib/action_view/base.rb, line 159 159: def render_file(template_path, use_full_path = true, local_assigns = {}) 160: @first_render = template_path if @first_render.nil? 161: 162: if use_full_path 163: template_extension = pick_template_extension(template_path) 164: template_file_name = full_template_path(template_path, template_extension) 165: else 166: template_file_name = template_path 167: template_extension = template_path.split(".").last 168: end 169: 170: template_source = read_template_file(template_file_name) 171: 172: begin 173: render_template(template_extension, template_source, local_assigns) 174: rescue Exception => e 175: if TemplateError === e 176: e.sub_template_of(template_file_name) 177: raise e 178: else 179: raise TemplateError.new(@base_path, template_file_name, @assigns, template_source, e) 180: end 181: end 182: end
Renders the template which is given as a string as either rhtml or rxml depending on template_extension. The hash in local_assigns is made available as local variables.
# File vendor/rails/actionpack/lib/action_view/base.rb, line 207 207: def render_template(template_extension, template, local_assigns = {}) 208: send(pick_rendering_method(template_extension), template_extension, 209: template, local_assigns) 210: end