123456789_123456789_123456789_123456789_123456789_

Module: ActionView::Helpers

Do not use. This module is for internal use only.
Relationships & Source Files
Namespace Children
Modules:
Classes:
Extension / Inclusion / Inheritance Descendants
Included In:
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
Instance Chain:
Defined in: actionview/lib/action_view/helpers.rb,
actionview/lib/action_view/helpers/active_model_helper.rb,
actionview/lib/action_view/helpers/asset_tag_helper.rb,
actionview/lib/action_view/helpers/asset_url_helper.rb,
actionview/lib/action_view/helpers/atom_feed_helper.rb,
actionview/lib/action_view/helpers/cache_helper.rb,
actionview/lib/action_view/helpers/capture_helper.rb,
actionview/lib/action_view/helpers/content_exfiltration_prevention_helper.rb,
actionview/lib/action_view/helpers/controller_helper.rb,
actionview/lib/action_view/helpers/csp_helper.rb,
actionview/lib/action_view/helpers/csrf_helper.rb,
actionview/lib/action_view/helpers/date_helper.rb,
actionview/lib/action_view/helpers/debug_helper.rb,
actionview/lib/action_view/helpers/form_helper.rb,
actionview/lib/action_view/helpers/form_options_helper.rb,
actionview/lib/action_view/helpers/form_tag_helper.rb,
actionview/lib/action_view/helpers/javascript_helper.rb,
actionview/lib/action_view/helpers/number_helper.rb,
actionview/lib/action_view/helpers/output_safety_helper.rb,
actionview/lib/action_view/helpers/rendering_helper.rb,
actionview/lib/action_view/helpers/sanitize_helper.rb,
actionview/lib/action_view/helpers/tag_helper.rb,
actionview/lib/action_view/helpers/tags.rb,
actionview/lib/action_view/helpers/text_helper.rb,
actionview/lib/action_view/helpers/translation_helper.rb,
actionview/lib/action_view/helpers/url_helper.rb,
actionview/lib/action_view/helpers/tags/base.rb,
actionview/lib/action_view/helpers/tags/check_box.rb,
actionview/lib/action_view/helpers/tags/checkable.rb,
actionview/lib/action_view/helpers/tags/collection_check_boxes.rb,
actionview/lib/action_view/helpers/tags/collection_helpers.rb,
actionview/lib/action_view/helpers/tags/collection_radio_buttons.rb,
actionview/lib/action_view/helpers/tags/collection_select.rb,
actionview/lib/action_view/helpers/tags/color_field.rb,
actionview/lib/action_view/helpers/tags/date_field.rb,
actionview/lib/action_view/helpers/tags/date_select.rb,
actionview/lib/action_view/helpers/tags/datetime_field.rb,
actionview/lib/action_view/helpers/tags/datetime_local_field.rb,
actionview/lib/action_view/helpers/tags/datetime_select.rb,
actionview/lib/action_view/helpers/tags/email_field.rb,
actionview/lib/action_view/helpers/tags/file_field.rb,
actionview/lib/action_view/helpers/tags/grouped_collection_select.rb,
actionview/lib/action_view/helpers/tags/hidden_field.rb,
actionview/lib/action_view/helpers/tags/label.rb,
actionview/lib/action_view/helpers/tags/month_field.rb,
actionview/lib/action_view/helpers/tags/number_field.rb,
actionview/lib/action_view/helpers/tags/password_field.rb,
actionview/lib/action_view/helpers/tags/placeholderable.rb,
actionview/lib/action_view/helpers/tags/radio_button.rb,
actionview/lib/action_view/helpers/tags/range_field.rb,
actionview/lib/action_view/helpers/tags/search_field.rb,
actionview/lib/action_view/helpers/tags/select.rb,
actionview/lib/action_view/helpers/tags/select_renderer.rb,
actionview/lib/action_view/helpers/tags/tel_field.rb,
actionview/lib/action_view/helpers/tags/text_area.rb,
actionview/lib/action_view/helpers/tags/text_field.rb,
actionview/lib/action_view/helpers/tags/time_field.rb,
actionview/lib/action_view/helpers/tags/time_select.rb,
actionview/lib/action_view/helpers/tags/time_zone_select.rb,
actionview/lib/action_view/helpers/tags/translator.rb,
actionview/lib/action_view/helpers/tags/url_field.rb,
actionview/lib/action_view/helpers/tags/week_field.rb,
actionview/lib/action_view/helpers/tags/weekday_select.rb

Constant Summary

AssetUrlHelper - Included

ASSET_EXTENSIONS, ASSET_PUBLIC_DIRECTORIES, URI_REGEXP

TagHelper - Included

ARIA_PREFIXES, BOOLEAN_ATTRIBUTES, DATA_PREFIXES, PRE_CONTENT_STRINGS, TAG_TYPES

AssetTagHelper - Included

MAX_HEADER_SIZE

ContentExfiltrationPreventionHelper - Included

CLOSE_CDATA_COMMENT, CLOSE_FORM_TAG, CLOSE_OPTION_TAG, CLOSE_QUOTES_COMMENT, CONTENT_EXFILTRATION_PREVENTION_MARKUP

ControllerHelper - Included

CONTROLLER_DELEGATES

DateHelper - Included

MINUTES_IN_QUARTER_YEAR, MINUTES_IN_THREE_QUARTERS_YEAR, MINUTES_IN_YEAR

UrlHelper - Included

BUTTON_TAG_METHOD_VERBS, STRINGIFIED_COMMON_METHODS

RecordIdentifier - Included

JOIN, NEW

JavaScriptHelper - Included

JS_ESCAPE_MAP

TranslationHelper - Included

MISSING_TRANSLATION, NO_DEFAULT

TranslationHelper - Attributes & Methods

Class Method Summary

::ActiveSupport::Concern - Extended

class_methods

Define class methods from given block.

included

Evaluate given block in context of base class, so that you can write class macros here.

prepended

Evaluate given block in context of base class, so that you can write class macros here.

append_features, prepend_features

::ActiveSupport::Autoload - Extended

Instance Attribute Summary

Instance Method Summary

TranslationHelper - Included

#l
#localize

Delegates to I18n.localize with no additional functionality.

#t
#translate

Delegates to I18n#translate but also performs three additional functions.

#missing_translation, #scope_key_by_partial

RenderingHelper - Included

#_layout_for

Overrides _layout_for in the context object so it supports the case a block is passed to a partial.

#render

Returns the result of a render that’s dictated by the options hash.

NumberHelper - Included

JavaScriptHelper - Included

#escape_javascript

Escapes carriage returns and single and double quotes for JavaScript segments.

#j
#javascript_tag

Returns a JavaScript tag with the content inside.

#javascript_cdata_section

FormOptionsHelper - Included

#collection_check_boxes

Returns check box tags for the collection of existing return values of method for object‘s class.

#collection_radio_buttons

Returns radio button tags for the collection of existing return values of method for object‘s class.

#collection_select

Returns <select> and <option> tags for the collection of existing return values of method for object‘s class.

#grouped_collection_select

Returns <select>, <optgroup> and <option> tags for the collection of existing return values of method for object‘s class.

#grouped_options_for_select

Returns a string of <option> tags, like options_for_select, but wraps them with <optgroup> tags:

#option_groups_from_collection_for_select

Returns a string of <option> tags, like options_from_collection_for_select, but groups them by <optgroup> tags based on the object relationships of the arguments.

#options_for_select

Accepts a container (hash, array, enumerable, your type) and returns a string of option tags.

#options_from_collection_for_select

Returns a string of option tags that have been compiled by iterating over the collection and assigning the result of a call to the value_method as the option value and the text_method as the option text.

#select

Create a select tag and a series of contained option tags for the provided object and method.

#time_zone_options_for_select

Returns a string of option tags for pretty much any time zone in the world.

#time_zone_select

Returns select and option tags for the given object and method, using #time_zone_options_for_select to generate the list of option tags.

#weekday_options_for_select

Returns a string of option tags for the days of the week.

#weekday_select

Returns select and option tags for the given object and method, using weekday_options_for_select to generate the list of option tags.

#extract_selected_and_disabled, #extract_values_from_collection, #option_html_attributes, #option_text_and_value, #option_value_selected?, #prompt_text, #value_for_collection

FormHelper - Included

#check_box

Returns a checkbox tag tailored for accessing a specified attribute (identified by method) on an object assigned to the template (identified by object).

#color_field

Returns a text_field of type “color”.

#date_field

Returns a text_field of type “date”.

#datetime_field

Returns a text_field of type “datetime-local”.

#datetime_local_field
#email_field

Returns a text_field of type “email”.

#fields

Scopes input fields with either an explicit scope or model.

#fields_for

Creates a scope around a specific model object like form_for, but doesn’t create the form tags themselves.

#file_field

Returns a file upload input tag tailored for accessing a specified attribute (identified by method) on an object assigned to the template (identified by object).

#form_for

Creates a form that allows the user to create or update the attributes of a specific model object.

#form_with

Creates a form tag based on mixing URLs, scopes, or models.

#hidden_field

Returns a hidden input tag tailored for accessing a specified attribute (identified by method) on an object assigned to the template (identified by object).

#label

Returns a label tag tailored for labelling an input field for a specified attribute (identified by method) on an object assigned to the template (identified by object).

#month_field

Returns a text_field of type “month”.

#number_field

Returns an input tag of type “number”.

#password_field

Returns an input tag of the “password” type tailored for accessing a specified attribute (identified by method) on an object assigned to the template (identified by object).

#phone_field
#radio_button

Returns a radio button tag for accessing a specified attribute (identified by method) on an object assigned to the template (identified by object).

#range_field

Returns an input tag of type “range”.

#search_field

Returns an input of type “search” for accessing a specified attribute (identified by method) on an object assigned to the template (identified by object_name).

#telephone_field

Returns a text_field of type “tel”.

#text_area

Returns a textarea opening and closing tag set tailored for accessing a specified attribute (identified by method) on an object assigned to the template (identified by object).

#text_field

Returns an input tag of the “text” type tailored for accessing a specified attribute (identified by method) on an object assigned to the template (identified by object).

#time_field

Returns a text_field of type “time”.

#url_field

Returns a text_field of type “url”.

#week_field

Returns a text_field of type “week”.

#default_form_builder_class, #html_options_for_form_with, #instantiate_builder, #_object_for_form_builder, #apply_form_for_options!

RecordIdentifier - Included

#dom_class

The DOM class convention is to use the singular form of an object or class.

#dom_id

The DOM id convention is to use the singular form of an object or class with the id following an underscore.

#record_key_for_dom_id

Returns a string representation of the key attribute(s) that is suitable for use in an HTML DOM id.

ModelNaming - Included

#convert_to_model

Converts the given object to an Active Model compliant one.

#model_name_from_record_or_class

FormTagHelper - Included

#button_tag

Creates a button element that defines a submit button, reset button or a generic button which can be used in JavaScript, for example.

#check_box_tag

Creates a check box form input tag.

#color_field_tag

Creates a text field of type “color”.

#date_field_tag

Creates a text field of type “date”.

#datetime_field_tag

Creates a text field of type “datetime-local”.

#datetime_local_field_tag
#email_field_tag

Creates a text field of type “email”.

#field_id

Generate an HTML id attribute value for the given name and field combination.

#field_name

Generate an HTML name attribute value for the given name and field combination.

#field_set_tag

Creates a field set for grouping HTML form elements.

#fieldset_tag
#file_field_tag

Creates a file upload field.

#form_tag

Starts a form tag that points the action to a URL configured with url_for_options just like ActionController::Base#url_for.

#hidden_field_tag

Creates a hidden form input field used to transmit data that would be lost due to HTTP’s statelessness or data that should be hidden from the user.

#image_submit_tag

Displays an image which when clicked will submit the form.

#label_tag

Creates a label element.

#month_field_tag

Creates a text field of type “month”.

#number_field_tag

Creates a number field.

#password_field_tag

Creates a password field, a masked text field that will hide the users input behind a mask character.

#phone_field_tag
#radio_button_tag

Creates a radio button; use groups of radio buttons named the same to allow users to select from a group of options.

#range_field_tag

Creates a range form element.

#search_field_tag

Creates a text field of type “search”.

#select_tag

Creates a dropdown selection box, or if the :multiple option is set to true, a multiple choice selection box.

#submit_tag

Creates a submit button with the text value as the caption.

#telephone_field_tag

Creates a text field of type “tel”.

#text_area_tag

Creates a text input area; use a textarea for longer text inputs such as blog posts or descriptions.

#text_field_tag

Creates a standard text field; use these text fields to input smaller chunks of text like a username or a search query.

#time_field_tag

Creates a text field of type “time”.

#url_field_tag

Creates a text field of type “url”.

#utf8_enforcer_tag

Creates the hidden UTF-8 enforcer tag.

#week_field_tag

Creates a text field of type “week”.

#convert_direct_upload_option_to_url, #extra_tags_for_form, #form_tag_html, #form_tag_with_body, #html_options_for_form,
#sanitize_to_id
#set_default_disable_with

TextHelper - Included

#concat

The preferred method of outputting text in your views is to use the <%= "text" %> eRuby syntax.

#current_cycle

Returns the current cycle string after a cycle has been started.

#cycle

Creates a Cycle object whose to_s method cycles through elements of an array every time it is called.

#excerpt

Extracts the first occurrence of phrase plus surrounding text from text.

#highlight

Highlights occurrences of phrases in text by formatting them with a highlighter string.

#pluralize

Attempts to pluralize the singular word unless count is 1.

#reset_cycle

Resets a cycle so that it starts from the first element the next time it is called.

#safe_concat,
#simple_format

Returns text transformed into HTML using simple formatting rules.

#truncate

Truncates text if it is longer than a specified :length.

#word_wrap

Wraps the text into lines no longer than line_width width.

#cut_excerpt_part,
#get_cycle

The cycle helpers need to store the cycles in a place that is guaranteed to be reset every time a page is rendered, so it uses an instance variable of Base.

#set_cycle, #split_paragraphs

SanitizeHelper - Included

#sanitize

Sanitizes HTML input, stripping all but known-safe tags and attributes.

#sanitize_css

Sanitizes a block of CSS code.

#strip_links

Strips all link tags from html leaving just the link text.

#strip_tags

Strips all HTML tags from html, including comments and special characters.

UrlHelper - Included

#button_to

Generates a form containing a single button that submits to the URL created by the set of options.

#current_page?

True if the current request URI was generated by the given options.

#link_to

Creates an anchor element of the given name using a URL created by the set of options.

#link_to_if

Creates a link tag of the given name using a URL created by the set of options if condition is true, otherwise only the name is returned.

#link_to_unless

Creates a link tag of the given name using a URL created by the set of options unless condition is true, in which case only the name is returned.

#link_to_unless_current

Creates a link tag of the given name using a URL created by the set of options unless the current request URI is the same as the links, in which case only the name is returned (or the given block is yielded, if one exists).

#mail_to

Creates a mailto link tag to the specified email_address, which is also used as the name of the link unless name is specified.

#phone_to

Creates a TEL anchor link tag to the specified phone_number.

#sms_to

Creates an SMS anchor link tag to the specified phone_number.

#add_method_to_attributes!, #convert_options_to_data_attributes, #link_to_remote_options?, #method_for_options, #method_not_get_method?, #method_tag, #remove_trailing_slash!,
#to_form_params

Returns an array of hashes each containing :name and :value keys suitable for use as the names and values of form input fields:

#token_tag, #url_target,
#url_for

Basic implementation of url_for to allow use helpers without routes existence.

#_back_url, #_filtered_referrer

DebugHelper - Included

#debug

Returns a YAML representation of object wrapped with <pre> and </pre>.

DateHelper - Included

#date_select

Returns a set of select tags (one for year, month, and day) pre-selected for accessing a specified date-based attribute (identified by method) on an object assigned to the template (identified by object).

#datetime_select

Returns a set of select tags (one for year, month, day, hour, and minute) pre-selected for accessing a specified datetime-based attribute (identified by method) on an object assigned to the template (identified by object).

#distance_of_time_in_words

Reports the approximate distance in time between two ::Time, ::Date, or ::DateTime objects or integers as seconds.

#distance_of_time_in_words_to_now
#select_date

Returns a set of HTML select-tags (one for year, month, and day) pre-selected with the date.

#select_datetime

Returns a set of HTML select-tags (one for year, month, day, hour, minute, and second) pre-selected with the datetime.

#select_day

Returns a select tag with options for each of the days 1 through 31 with the current day selected.

#select_hour

Returns a select tag with options for each of the hours 0 through 23 with the current hour selected.

#select_minute

Returns a select tag with options for each of the minutes 0 through 59 with the current minute selected.

#select_month

Returns a select tag with options for each of the months January through December with the current month selected.

#select_second

Returns a select tag with options for each of the seconds 0 through 59 with the current second selected.

#select_time

Returns a set of HTML select-tags (one for hour and minute).

#select_year

Returns a select tag with options for each of the five years on each side of the current, which is selected.

#time_ago_in_words

Like distance_of_time_in_words, but where to_time is fixed to Time.now.

#time_select

Returns a set of select tags (one for hour, minute, and optionally second) pre-selected for accessing a specified time-based attribute (identified by method) on an object assigned to the template (identified by object).

#time_tag

Returns an HTML time tag for the given date or time.

#normalize_distance_of_time_argument_to_time

CsrfHelper - Included

#csrf_meta_tag
#csrf_meta_tags

Returns meta tags “csrf-param” and “csrf-token” with the name of the cross-site request forgery protection parameter and token, respectively.

CspHelper - Included

#csp_meta_tag

Returns a meta tag “csp-nonce” with the per-session nonce value for allowing inline <script> tags.

ControllerHelper - Included

ContentExfiltrationPreventionHelper - Included

CacheHelper - Included

#cache

This helper exposes a method for caching fragments of a view rather than an entire action or page.

#cache_fragment_name

This helper returns the name of a cache key for a given fragment cache call.

#cache_if

Cache fragments of a view if condition is true.

#cache_unless

Cache fragments of a view unless condition is true.

#uncacheable!

Raises UncacheableFragmentError when called from within a cache block.

#fragment_for, #fragment_name_with_digest, #read_fragment_for, #write_fragment_for, #digest_path_from_template

AtomFeedHelper - Included

#atom_feed

Adds easy defaults to writing Atom feeds with the Builder template engine (this does not work on ::ERB or any other template languages).

AssetTagHelper - Included

#audio_tag

Returns an HTML audio tag for the sources.

#auto_discovery_link_tag

Returns a link tag that browsers and feed readers can use to auto-detect an RSS, Atom, or JSON feed.

#favicon_link_tag

Returns a link tag for a favicon managed by the asset pipeline.

#image_tag

Returns an HTML image tag for the source.

#javascript_include_tag

Returns an HTML script tag for each of the sources provided.

#picture_tag

Returns an HTML picture tag for the sources.

#preload_link_tag

Returns a link tag that browsers can use to preload the source.

#stylesheet_link_tag

Returns a stylesheet link tag for the sources specified as arguments.

#video_tag

Returns an HTML video tag for the sources.

#check_for_image_tag_errors, #extract_dimensions, #multiple_sources_tag_builder, #resolve_asset_source, #resolve_link_as, #send_preload_links_header

TagHelper - Included

#cdata_section

Returns a CDATA section with the given content.

#class_names
#content_tag

Returns an HTML block tag of type name surrounding the content.

#escape_once

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

#tag

Returns an HTML tag.

#token_list

Returns a string of tokens built from args.

#build_tag_values, #ensure_valid_html5_tag_name, #tag_builder

OutputSafetyHelper - Included

#raw

This method outputs without escaping a string.

#safe_join

This method returns an HTML safe string similar to what Array#join would return.

#to_sentence

Converts the array to a comma-separated sentence where the last element is joined by the connector word.

CaptureHelper - Included

#capture

The capture method extracts part of a template as a string object.

#content_for

Calling content_for stores a block of markup in an identifier for later use.

#content_for?

content_for? checks whether any content has been captured yet using content_for.

#provide

The same as content_for but when used with streaming flushes straight back to the layout.

#with_output_buffer

Use an alternate output buffer for the duration of the block.

AssetUrlHelper - Included

#asset_path

This is the entry point for all assets.

#asset_url

Computes the full URL to an asset in the public directory.

#audio_path

Computes the path to an audio asset in the public audios directory.

#audio_url

Computes the full URL to an audio asset in the public audios directory.

#compute_asset_extname

Compute extname to append to asset path.

#compute_asset_host

Pick an asset host for this source.

#compute_asset_path

Computes asset path to public directory.

#font_path

Computes the path to a font asset.

#font_url

Computes the full URL to a font asset.

#image_path

Computes the path to an image asset.

#image_url

Computes the full URL to an image asset.

#javascript_path

Computes the path to a JavaScript asset in the public javascripts directory.

#javascript_url

Computes the full URL to a JavaScript asset in the public javascripts directory.

#path_to_asset
#path_to_audio
#path_to_font
#path_to_image
#path_to_javascript
#path_to_stylesheet
#path_to_video
#public_compute_asset_path
#stylesheet_path

Computes the path to a stylesheet asset in the public stylesheets directory.

#stylesheet_url

Computes the full URL to a stylesheet asset in the public stylesheets directory.

#url_to_asset
#url_to_audio
#url_to_font
#url_to_image
#url_to_javascript
#url_to_stylesheet
#url_to_video
#video_path

Computes the path to a video asset in the public videos directory.

#video_url

Computes the full URL to a video asset in the public videos directory.

::ActiveSupport::Benchmarkable - Included

#benchmark

Allows you to measure the execution time of a block in a template and records the result to the log.

Class Attribute Details

.debug_missing_translation (rw) Also known as: #debug_missing_translation

[ GitHub ]

  
# File 'actionview/lib/action_view/helpers/translation_helper.rb', line 18

mattr_accessor :debug_missing_translation, default: true

Class Method Details

.eager_load!

[ GitHub ]

  
# File 'actionview/lib/action_view/helpers.rb', line 35

def self.eager_load!
  super
  Tags.eager_load!
end

Instance Attribute Details

#debug_missing_translation (rw)

[ GitHub ]

  
# File 'actionview/lib/action_view/helpers/translation_helper.rb', line 18

mattr_accessor :debug_missing_translation, default: true