i18n

Documentation

Index

• func GetCurrentLanguage() string
• func GetEnableLanguage() string
• func LT(locale, content string) string
• func LTf(locale, format string, values ...interface{}) string
• func LocaleLoadHook(db *gorm.DB)
• func LocaleUpdateHook(db *gorm.DB)
• func Start()
• func T(content string) string
• func Tf(format string, values ...interface{}) string
• type I18nEnabled
• type I18nFactory
• type LocaleFieldValue
• type Manager
  • func New(options ...Options) *Manager
  • func (m *Manager) GetContent(key string) interface{}
  • func (m *Manager) LT(locale, content string) string
  • func (m *Manager) LTf(locale, format string, values ...interface{}) string
  • func (m *Manager) LocaleTranslate(lang, content string) string
  • func (m *Manager) LocaleTranslateFormat(locale, format string, values ...interface{}) string
  • func (m *Manager) SetDelimiters(left, right string)
  • func (m *Manager) SetLanguage(language string)
  • func (m *Manager) SetPath(path string) error
  • func (m *Manager) T(content string) string
  • func (m *Manager) Translate(content string) string
  • func (m *Manager) TranslateFormat(format string, values ...interface{}) string
• type Options
• type Translator

Functions

func GetCurrentLanguage

func GetCurrentLanguage() string

func GetEnableLanguage

func GetEnableLanguage() string

func LT

func LT(locale, content string) string

func LTf

func LTf(locale, format string, values ...interface{}) string

func LocaleLoadHook

func LocaleLoadHook(db *gorm.DB)

2. get locale fields

func LocaleUpdateHook

func LocaleUpdateHook(db *gorm.DB)

1. store locale fields

func Start

func Start()

func T

func T(content string) string

func Tf

func Tf(format string, values ...interface{}) string

Types

type I18nEnabled

type I18nEnabled struct {
	LocaleFields []*LocaleFieldValue `gorm:"-" json:"-"`
}

type I18nFactory

type I18nFactory struct {
	Translator Translator `inject:"translator"`
}

type LocaleFieldValue

type LocaleFieldValue struct {
	EntityName string `gorm:"column:entity_name;primaryKey" json:"entityName"`
	EntityId   string `gorm:"column:entity_id;primaryKey" json:"entityId"`
	Name       string `gorm:"column:name;primaryKey" json:"name"`
	Locale     string `gorm:"column:locale;default:en;primaryKey" json:"locale"`
	Value      string `gorm:"column:value" json:"value"`
}

type Manager

type Manager struct {
	// contains filtered or unexported fields
}

Manager for i18n contents, it is concurrent safe, supporting hot reload.

func New

func New(options ...Options) *Manager

New creates and returns a new i18n manager. The optional parameter `option` specifies the custom options for i18n manager. It uses a default one if it's not passed.

func (*Manager) GetContent

func (m *Manager) GetContent(key string) interface{}

GetContent retrieves and returns the configured content for given key and specified language. It returns an empty string if not found.

func (*Manager) LT

func (m *Manager) LT(locale, content string) string

T is alias of Translate for convenience.

func (*Manager) LTf

func (m *Manager) LTf(locale, format string, values ...interface{}) string

Tf is alias of TranslateFormat for convenience.

func (*Manager) LocaleTranslate

func (m *Manager) LocaleTranslate(lang, content string) string

func (*Manager) LocaleTranslateFormat

func (m *Manager) LocaleTranslateFormat(locale, format string, values ...interface{}) string

TranslateFormat translates, formats and returns the `format` with configured language and given `values`.

func (*Manager) SetDelimiters

func (m *Manager) SetDelimiters(left, right string)

SetDelimiters sets the delimiters for translator.

func (*Manager) SetLanguage

func (m *Manager) SetLanguage(language string)

SetLanguage sets the language for translator.

func (*Manager) SetPath

func (m *Manager) SetPath(path string) error

SetPath sets the directory path storing i18n files.

func (*Manager) T

func (m *Manager) T(content string) string

T is alias of Translate for convenience.

func (*Manager) Translate

func (m *Manager) Translate(content string) string

Translate translates `content` with configured language.

func (*Manager) TranslateFormat

func (m *Manager) TranslateFormat(format string, values ...interface{}) string

TranslateFormat translates, formats and returns the `format` with configured language and given `values`.

type Options

type Options struct {
	Path       string   // I18n files storage path.
	Language   string   // Default local language.
	Delimiters []string // Delimiters for variable parsing.
}

Options is used for i18n object configuration.

type Translator

type Translator interface {
	StoreTranslations(translations []*LocaleFieldValue)
	LoadTranslations(locale, entityName string, entityId ...string) map[string][]*LocaleFieldValue
}