Included Modules

Class Index [+]

Quicksearch

ActionView::Helpers::TagHelper

Provides methods to generate HTML tags programmatically when you can’t use a Builder. By default, they output XHTML compliant tags.

Constants

BOOLEAN_ATTRIBUTES

Public Instance Methods

cdata_section(content) click to toggle source

Returns a CDATA section with the given content. CDATA sections are used to escape blocks of text containing characters which would otherwise be recognized as markup. CDATA sections begin with the string <![CDATA[ and end with (and may not contain) the string ]]>.

Examples

  cdata_section("<hello world>")
  # => <![CDATA[<hello world>]]>

  cdata_section(File.read("hello_world.txt"))
  # => <![CDATA[<hello from a text file]]>
    # File lib/action_view/helpers/tag_helper.rb, line 94
94:       def cdata_section(content)
95:         "<![CDATA[#{content}]]>".html_safe
96:       end
content_tag(name, content_or_options_with_block = nil, options = nil, escape = true, &block) click to toggle source

Returns an HTML block tag of type name surrounding the content. Add HTML attributes by passing an attributes hash to options. Instead of passing the content as an argument, you can also use a block in which case, you pass your options as the second parameter. Set escape to false to disable attribute value escaping.

Options

The options hash is used with attributes with no value like (disabled and readonly), which you can give a value of true in the options hash. You can use symbols or strings for the attribute names.

Examples

  content_tag(:p, "Hello world!")
   # => <p>Hello world!</p>
  content_tag(:div, content_tag(:p, "Hello world!"), :class => "strong")
   # => <div class="strong"><p>Hello world!</p></div>
  content_tag("select", options, :multiple => true)
   # => <select multiple="multiple">...options...</select>

  <%= content_tag :div, :class => "strong" do -%>
    Hello world!
  <% end -%>
   # => <div class="strong">Hello world!</div>
    # File lib/action_view/helpers/tag_helper.rb, line 74
74:       def content_tag(name, content_or_options_with_block = nil, options = nil, escape = true, &block)
75:         if block_given?
76:           options = content_or_options_with_block if content_or_options_with_block.is_a?(Hash)
77:           content_tag_string(name, capture(&block), options, escape)
78:         else
79:           content_tag_string(name, content_or_options_with_block, options, escape)
80:         end
81:       end
escape_once(html) click to toggle source

Returns an escaped version of html without affecting existing escaped entities.

Examples

  escape_once("1 < 2 &amp; 3")
  # => "1 &lt; 2 &amp; 3"

  escape_once("&lt;&lt; Accept & Checkout")
  # => "&lt;&lt; Accept &amp; Checkout"
     # File lib/action_view/helpers/tag_helper.rb, line 106
106:       def escape_once(html)
107:         ActiveSupport::Multibyte.clean(html.to_s).gsub(/[\"><]|&(?!([a-zA-Z]+|(#\d+));)/) { |special| ERB::Util::HTML_ESCAPE[special] }
108:       end
tag(name, options = nil, open = false, escape = true) click to toggle source

Returns an empty HTML tag of type name which by default is XHTML compliant. Set open to true to create an open tag compatible with HTML 4.0 and below. Add HTML attributes by passing an attributes hash to options. Set escape to false to disable attribute value escaping.

Options

The options hash is used with attributes with no value like (disabled and readonly), which you can give a value of true in the options hash. You can use symbols or strings for the attribute names.

Examples

  tag("br")
  # => <br />

  tag("br", nil, true)
  # => <br>

  tag("input", { :type => 'text', :disabled => true })
  # => <input type="text" disabled="disabled" />

  tag("img", { :src => "open & shut.png" })
  # => <img src="open &amp; shut.png" />

  tag("img", { :src => "open &amp; shut.png" }, false, false)
  # => <img src="open &amp; shut.png" />
    # File lib/action_view/helpers/tag_helper.rb, line 47
47:       def tag(name, options = nil, open = false, escape = true)
48:         "<#{name}#{tag_options(options, escape) if options}#{open ? ">" : " />"}".html_safe
49:       end

Private Instance Methods

content_tag_string(name, content, options, escape = true) click to toggle source
     # File lib/action_view/helpers/tag_helper.rb, line 112
112:         def content_tag_string(name, content, options, escape = true)
113:           tag_options = tag_options(options, escape) if options
114:           "<#{name}#{tag_options}>#{escape ? ERB::Util.h(content) : content}</#{name}>".html_safe
115:         end
tag_options(options, escape = true) click to toggle source
     # File lib/action_view/helpers/tag_helper.rb, line 117
117:         def tag_options(options, escape = true)
118:           unless options.blank?
119:             attrs = []
120:             options.each_pair do |key, value|
121:               if BOOLEAN_ATTRIBUTES.include?(key)
122:                 attrs << %(#{key}="#{key}") if value
123:               elsif !value.nil?
124:                 final_value = value.is_a?(Array) ? value.join(" ") : value
125:                 final_value = html_escape(final_value) if escape
126:                 attrs << %(#{key}="#{final_value}")
127:               end
128:             end
129:             " #{attrs.sort * ' '}".html_safe unless attrs.empty?
130:           end
131:         end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.