Class: I18n::Backend::ActiveRecord

Inherits:

Object

Object
I18n::Backend::ActiveRecord

show all

Includes:: Implementation

Defined in:: lib/active_support/vendor/i18n-0.4.1/i18n/backend/active_record/translation.rb,
lib/active_support/vendor/i18n-0.4.1/i18n/backend/active_record.rb,
lib/active_support/vendor/i18n-0.4.1/i18n/backend/active_record/missing.rb,
lib/active_support/vendor/i18n-0.4.1/i18n/backend/active_record/store_procs.rb

Overview

ActiveRecord model used to store actual translations to the database.

This model expects a table like the following to be already set up in your the database:

create_table :translations do |t|
  t.string :locale
  t.string :key
  t.text   :value
  t.text   :interpolations
  t.boolean :is_proc, :default => false
end

This model supports to named scopes :locale and :lookup. The :locale scope simply adds a condition for a given locale:

I18n::Backend::ActiveRecord::Translation.locale(:en).all
# => all translation records that belong to the :en locale

The :lookup scope adds a condition for looking up all translations that either start with the given keys (joined by an optionally given separator or I18n.default_separator) or that exactly have this key.

# with translations present for :"foo.bar" and :"foo.baz"
I18n::Backend::ActiveRecord::Translation.lookup(:foo)
# => an array with both translation records :"foo.bar" and :"foo.baz"

I18n::Backend::ActiveRecord::Translation.lookup([:foo, :bar])
I18n::Backend::ActiveRecord::Translation.lookup(:"foo.bar")
# => an array with the translation record :"foo.bar"

When the StoreProcs module was mixed into this model then Procs will be stored to the database as Ruby code and evaluated when :value is called.

Translation = I18n::Backend::ActiveRecord::Translation
Translation.create \
  :locale => 'en'
  :key    => 'foo'
  :value  => lambda { |key, options| 'FOO' }
Translation.find_by_locale_and_key('en', 'foo').value
# => 'FOO'