Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type LanguageFinder ¶
type LanguageFinder func(*Translator, buffalo.Context) []string
LanguageFinder can be implemented for custom finding of search languages. This can be useful if you want to load a user's language from something like a database. See Middleware() for more information on how the default implementation searches for languages.
type Translator ¶
type Translator struct {
// Box - where are the files?
Box packr.Box
// DefaultLanguage - default is passed as a parameter on New.
DefaultLanguage string
// CookieName - name of the cookie to find the desired language.
// default is "lang"
CookieName string
// SessionName - name of the session to find the desired language.
// default is "lang"
SessionName string
// HelperName - name of the view helper. default is "t"
HelperName string
LanguageFinder LanguageFinder
}
Translator for handling all your i18n needs.
func New ¶
func New(box packr.Box, language string) (*Translator, error)
New Translator. Requires a packr.Box that points to the location of the translation files, as well as a default language. This will also call t.Load() and load the translations from disk.
func (*Translator) AddTranslation ¶
func (t *Translator) AddTranslation(lang *language.Language, translations ...translation.Translation)
AddTranslation directly, without using a file. This is useful if you wish to load translations from a database, instead of disk.
func (*Translator) Middleware ¶
func (t *Translator) Middleware() buffalo.MiddlewareFunc
Middleware for loading the translations for the language(s) selected. By default languages are loaded in the following order:
Cookie - "lang" Session - "lang" Header - "Accept-Language" Default - "en-US"
These values can be changed on the Translator itself. In development model the translation files will be reloaded on each request.
func (*Translator) Translate ¶
func (t *Translator) Translate(c buffalo.Context, translationID string, args ...interface{}) string
Translate returns the translation of the string identified by translationID.
See https://github.com/nicksnyder/go-i18n
If there is no translation for translationID, then the translationID itself is returned. This makes it easy to identify missing translations in your app.
If translationID is a non-plural form, then the first variadic argument may be a map[string]interface{} or struct that contains template data.
If translationID is a plural form, the function accepts two parameter signatures 1. T(count int, data struct{}) The first variadic argument must be an integer type (int, int8, int16, int32, int64) or a float formatted as a string (e.g. "123.45"). The second variadic argument may be a map[string]interface{} or struct{} that contains template data. 2. T(data struct{}) data must be a struct{} or map[string]interface{} that contains a Count field and the template data, Count field must be an integer type (int, int8, int16, int32, int64) or a float formatted as a string (e.g. "123.45").
Source Files