instance method `translate`

Ruby on Rails 2.3.18

Since v2.2.3

Available in: v2.2.3 v2.3.18 v3.0.20 v3.1.12 v3.2.22.5 v4.0.13 v4.1.16 v4.2.9 v5.2.8.1 v6.0.6 v6.1.7.10 v7.0.10 v7.1.6 v7.2.3 v8.0.4 v8.1.2

Compare with:

translate(keys, options = {})

Delegates to I18n#translate but also performs two additional functions. First, it’ll catch MissingTranslationData exceptions and turn them into inline spans that contains the missing key, such that you can see in a view what is missing where.

Second, it’ll scope the key by the current partial if the key starts with a period. So if you call translate(“.foo”) from the people/index.html.erb template, you’ll actually be calling I18n.translate(“people.index.foo”). This makes it less repetitive to translate many keys within the same partials and gives you a simple framework for scoping them consistently. If you don’t prepend the key with a period, nothing is converted.

Parameters

keys req
options opt = {}

Source

# File actionpack/lib/action_view/helpers/translation_helper.rb, line 13
      def translate(keys, options = {})
        if multiple_keys = keys.is_a?(Array)
          ActiveSupport::Deprecation.warn "Giving an array to translate is deprecated, please give a symbol or a string instead", caller
        end

        options[:raise] = true
        keys = scope_keys_by_partial(keys)

        translations = I18n.translate(keys, options)
        translations = [translations] if !multiple_keys && translations.size > 1
        translations = html_safe_translation_keys(keys, translations)

        if multiple_keys || translations.size > 1
          translations
        else
          translations.first
        end
      rescue I18n::MissingTranslationData => e
        keys = I18n.send(:normalize_translation_keys, e.locale, e.key, e.options[:scope])
        content_tag('span', keys.join(', '), :class => 'translation_missing')
      end

Defined in actionpack/lib/action_view/helpers/translation_helper.rb line 13 · View on GitHub · Improve this page · Find usages on GitHub

Defined in ActionView::Helpers::TranslationHelper

Signature

Parameters