instance method `translate`

Ruby on Rails 7.0.10

Since v3.0.20

Available in: 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(key, **options)

Delegates to I18n.translate.

When the given key starts with a period, it will be scoped by the current controller and action. So if you call translate(".foo") from PeopleController#index, it will convert the call to I18n.translate("people.index.foo"). This makes it less repetitive to translate many keys within the same controller / action and gives you a simple framework for scoping them consistently.

Parameters

key req
options keyrest

Source

# File actionpack/lib/abstract_controller/translation.rb, line 17
    def translate(key, **options)
      if key&.start_with?(".")
        path = controller_path.tr("/", ".")
        defaults = [:"#{path}#{key}"]
        defaults << options[:default] if options[:default]
        options[:default] = defaults.flatten
        key = "#{path}.#{action_name}#{key}"
      end

      i18n_raise = options.fetch(:raise, self.raise_on_missing_translations)

      if options[:default]
        options[:default] = [options[:default]] unless options[:default].is_a?(Array)
        options[:default] = options[:default].map do |value|
          value.is_a?(String) ? ERB::Util.html_escape(value) : value
        end
      end

      unless i18n_raise
        options[:default] = [] unless options[:default]
        options[:default] << MISSING_TRANSLATION
      end

      result = ActiveSupport::HtmlSafeTranslation.translate(key, **options, raise: i18n_raise)

      if result == MISSING_TRANSLATION
        +"translation missing: #{key}"
      else
        result
      end
    end

Defined in actionpack/lib/abstract_controller/translation.rb line 17 · View on GitHub · Improve this page · Find usages on GitHub

Defined in AbstractController::Translation

Signature

Parameters