mrlang

Documentation

Index

• func ParseAcceptLanguage(s string) []string
• func WithContext(ctx context.Context, locale *Locale) context.Context
• type Dictionary
  • func (d *Dictionary) ItemByID(id int) DictionaryItemAttrs
  • func (d *Dictionary) ItemByKey(key string) DictionaryItemAttrs
  • func (d *Dictionary) RegisteredItems() []string
• type DictionaryItemAttrs
  • func (a DictionaryItemAttrs) Attr(name, defaultText string) string
  • func (a DictionaryItemAttrs) RegisteredAttrs() []string
• type DictionaryMap
• type Locale
  • func Ctx(ctx context.Context) *Locale
  • func (l *Locale) HasErrorCode(code string) bool
  • func (l *Locale) LangCode() string
  • func (l *Locale) LangID() uint16
  • func (l *Locale) TranslateError(code, defaultMessage string, args ...mrmsg.NamedArg) mrmsg.ErrorMessage
  • func (l *Locale) TranslateMessage(code, defaultMessage string, args ...mrmsg.NamedArg) string
  • func (l *Locale) WithContext(ctx context.Context) context.Context
• type MultiLangDictionary
  • func (d *MultiLangDictionary) ByLangCode(code string) (*Dictionary, error)
  • func (d *MultiLangDictionary) ByLangID(id uint16) (*Dictionary, error)
  • func (d *MultiLangDictionary) Name() string
  • func (d *MultiLangDictionary) RegisteredLangs() []string
• type Translator
  • func NewTranslator(opts TranslatorOptions) (*Translator, error)
  • func (t *Translator) DefaultLocale() *Locale
  • func (t *Translator) Dictionary(name string) (*MultiLangDictionary, error)
  • func (t *Translator) FindFirstLocale(langs ...string) *Locale
  • func (t *Translator) LocaleByCode(lang string) (*Locale, error)
  • func (t *Translator) LocaleByID(langID uint16) (*Locale, error)
  • func (t *Translator) RegisteredDictionaries() []string
  • func (t *Translator) RegisteredLocales() []string
• type TranslatorOptions

Functions

func ParseAcceptLanguage

func ParseAcceptLanguage(s string) []string

ParseAcceptLanguage - извлечение данных о языках. Sample Accept-Language: ru;q=0.9, fr-CH, fr;q=0.8, en;q=0.7, *;q=0.5.

func WithContext

func WithContext(ctx context.Context, locale *Locale) context.Context

WithContext - возвращает указанный контекст с обогащённый объектом Locale.

Types

type Dictionary

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

Dictionary - справочник объектов указанного типа на конкретном языке.

func (*Dictionary) ItemByID

func (d *Dictionary) ItemByID(id int) DictionaryItemAttrs

ItemByID - возвращает объект с его атрибутами по ID.

func (*Dictionary) ItemByKey

func (d *Dictionary) ItemByKey(key string) DictionaryItemAttrs

ItemByKey - возвращает объект с его атрибутами по ключу (строковому ID).

func (*Dictionary) RegisteredItems

func (d *Dictionary) RegisteredItems() []string

RegisteredItems - возвращает список ключей зарегистрированных объектов.

type DictionaryItemAttrs

type DictionaryItemAttrs map[string]string

DictionaryItemAttrs - список имён атрибутов и их значений.

func (DictionaryItemAttrs) Attr

func (a DictionaryItemAttrs) Attr(name, defaultText string) string

Attr - возвращает значение атрибута по его имени или defaultText если имя не найдено.

func (DictionaryItemAttrs) RegisteredAttrs

func (a DictionaryItemAttrs) RegisteredAttrs() []string

RegisteredAttrs - возвращает список имён зарегистрированных атрибутов объекта.

type DictionaryMap

type DictionaryMap map[string]DictionaryItemAttrs

DictionaryMap - атрибуты объекта на конкретном языке. dictionary-name -> [id -> [attr1 -> text1, attr2 -> text2, ...], ...].

type Locale

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

Locale - список сообщений и пользовательских ошибок на конкретном языке.

func Ctx

func Ctx(ctx context.Context) *Locale

Ctx - возвращает объект Locale из указанного контекста.

func (*Locale) HasErrorCode

func (l *Locale) HasErrorCode(code string) bool

HasErrorCode - проверяется зарегистрирован указанный код ошибки в общем справочнике.

func (*Locale) LangCode

func (l *Locale) LangCode() string

LangCode - возвращает код языка.

func (*Locale) LangID

func (l *Locale) LangID() uint16

LangID - возвращает ID языка.

func (*Locale) TranslateError

func (l *Locale) TranslateError(code, defaultMessage string, args ...mrmsg.NamedArg) mrmsg.ErrorMessage

TranslateError - возвращает сообщение об ошибке по указанному коду на текущем языке, если код не найден, то возвращает сообщение по умолчанию.

func (*Locale) TranslateMessage

func (l *Locale) TranslateMessage(code, defaultMessage string, args ...mrmsg.NamedArg) string

TranslateMessage - возвращает сообщение по указанному коду на текущем языке, если код не найден, то возвращает сообщение по умолчанию.

func (*Locale) WithContext

func (l *Locale) WithContext(ctx context.Context) context.Context

WithContext - возвращает контекст с вложенным в него объектом Locale.

type MultiLangDictionary

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

MultiLangDictionary - мультиязычный справочник объектов одного типа.

func (*MultiLangDictionary) ByLangCode

func (d *MultiLangDictionary) ByLangCode(code string) (*Dictionary, error)

ByLangCode - возвращает справочник на указанном языке (code) или ошибку если язык не был найден.

func (*MultiLangDictionary) ByLangID

func (d *MultiLangDictionary) ByLangID(id uint16) (*Dictionary, error)

ByLangID - возвращает справочник на указанном языке (ID) или ошибку если язык не был найден.

func (*MultiLangDictionary) Name

func (d *MultiLangDictionary) Name() string

Name - название справочника.

func (*MultiLangDictionary) RegisteredLangs

func (d *MultiLangDictionary) RegisteredLangs() []string

RegisteredLangs - возвращает список ключей зарегистрированных языков справочника.

type Translator

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

Translator - загружает и транслирует сообщения, ошибки, справочники объектов на различные языки.

func NewTranslator

func NewTranslator(opts TranslatorOptions) (*Translator, error)

NewTranslator - создаёт объект Translator.

func (*Translator) DefaultLocale

func (t *Translator) DefaultLocale() *Locale

DefaultLocale - возвращает языковой объект по умолчанию.

func (*Translator) Dictionary

func (t *Translator) Dictionary(name string) (*MultiLangDictionary, error)

Dictionary - возвращает мультиязычный справочник по его имени.

func (*Translator) FindFirstLocale

func (t *Translator) FindFirstLocale(langs ...string) *Locale

FindFirstLocale - возвращает первый языковой объект по указанным языковым кодам. Если ни один языковой код не зарегистрирован, то возвращает языковой объект по умолчанию.

func (*Translator) LocaleByCode

func (t *Translator) LocaleByCode(lang string) (*Locale, error)

LocaleByCode - возвращает языковой объект по его коду.

func (*Translator) LocaleByID

func (t *Translator) LocaleByID(langID uint16) (*Locale, error)

LocaleByID - возвращает языковой объект по его ID.

func (*Translator) RegisteredDictionaries

func (t *Translator) RegisteredDictionaries() []string

RegisteredDictionaries - возвращает список имён зарегистрированных мультиязычных справочников.

func (*Translator) RegisteredLocales

func (t *Translator) RegisteredLocales() []string

RegisteredLocales - возвращает список кодов зарегистрированных языков.

type TranslatorOptions

type TranslatorOptions struct {
	DirPath           string
	LangCodes         []string
	DefaultLang       string // optional
	DictionaryDirPath string
	Dictionaries      []string // optional
}

TranslatorOptions - опции для создания Translator.