Class: I18n::Backend::ActiveRecord

Inherits:
Object
  • Object
show all
Includes:
Implementation
Defined in:
lib/i18n/backend/active_record/translation.rb,
lib/i18n/backend/active_record.rb,
lib/i18n/backend/active_record/missing.rb,
lib/i18n/backend/active_record/store_procs.rb,
lib/i18n/backend/active_record/configuration.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'

Defined Under Namespace

Modules: Implementation, Missing, StoreProcs, TranslationModel Classes: Configuration, Translation

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Implementation

#available_locales, #init_translations, #initialized?, #reload!, #store_translations, #translations

Constructor Details

#initialize ⇒ ActiveRecord

Returns a new instance of ActiveRecord.



24
25
26
 
# File 'lib/i18n/backend/active_record.rb', line 24

def initialize
  reload!
end

Class Method Details

.config ⇒ Object 



19
20
21
 
# File 'lib/i18n/backend/active_record.rb', line 19

def config
  @config ||= Configuration.new
end

.configure {|config| ... } ⇒ Object

Yields:



15
16
17
 
# File 'lib/i18n/backend/active_record.rb', line 15

def configure
  yield(config) if block_given?
end