langs

README

langs

Translation helpers.

Install

go get github.com/altipla-consulting/langs

Contributing

You can make pull requests or create issues in GitHub. Any code you send should be formatted using make gofmt.

License

MIT License

Documentation

Overview

Package langs contains translation helpers.

Index

• Variables
• func IsValid(lang string) bool
• func NativeName(lang Lang) string
• type Chain
  • func NewChain(fallbacks ...Lang) Chain
• type Content
  • func NewContent() Content
  • func NewContentFromMap(values map[Lang]string) Content
  • func NewContentValue(lang Lang, value string) Content
  • func ParseContent(values map[string]string) (Content, error)
  • func (content *Content) Clear(lang Lang)
  • func (content *Content) ClearAll()
  • func (content Content) Get(lang Lang) string
  • func (content Content) GetChain(chain Chain, lang Lang) string
  • func (content Content) IsEmpty() bool
  • func (content Content) Map() map[Lang]string
  • func (content Content) MarshalJSON() ([]byte, error)
  • func (content Content) PlainMap() map[string]string
  • func (content *Content) Scan(value interface{}) error
  • func (content *Content) Set(lang Lang, value string)
  • func (content *Content) UnmarshalJSON(b []byte) error
  • func (content Content) Value() (driver.Value, error)
• type Lang
  • func Parse(lang string) (Lang, error)
  • func (l Lang) Empty() bool
  • func (lang Lang) MarshalJSON() ([]byte, error)
  • func (lang Lang) MarshalText() ([]byte, error)
  • func (lang *Lang) Scan(src any) error
  • func (lang Lang) String() string
  • func (lang *Lang) UnmarshalJSON(b []byte) error
  • func (lang *Lang) UnmarshalText(text []byte) error
  • func (lang Lang) Value() (driver.Value, error)

Variables

var (
	CA   = Lang{Code: "ca", Native: "Català", Group: "ca"}
	DE   = Lang{Code: "de", Native: "Deutsch", Group: "de"}
	DeDE = Lang{Code: "de-DE", Native: "Deutsch", Group: "de"}
	EN   = Lang{Code: "en", Native: "English", Group: "en"}
	EnGB = Lang{Code: "en-GB", Native: "English", Group: "en"}
	EnUS = Lang{Code: "en-US", Native: "English", Group: "en"}
	ES   = Lang{Code: "es", Native: "Español", Group: "es"}
	EsES = Lang{Code: "es-ES", Native: "Español", Group: "es"}
	EU   = Lang{Code: "eu", Native: "Euskera", Group: "eu"}
	FR   = Lang{Code: "fr", Native: "Français", Group: "fr"}
	FrFR = Lang{Code: "fr-FR", Native: "Français", Group: "fr"}
	IT   = Lang{Code: "it", Native: "Italiano", Group: "it"}
	JA   = Lang{Code: "ja", Native: "日本語", Group: "ja"}
	PT   = Lang{Code: "pt", Native: "Portugues", Group: "pt"}
	PtPT = Lang{Code: "pt-PT", Native: "Portugues", Group: "pt"}
	RU   = Lang{Code: "ru", Native: "Русский", Group: "ru"}

	Empty = Lang{}
)

var All = []Lang{
	CA,
	DE,
	DeDE,
	EN,
	EnGB,
	EnUS,
	ES,
	EsES,
	EU,
	FR,
	FrFR,
	IT,
	JA,
	PT,
	PtPT,
	RU,
}

All contains all the known languages of this library.

Functions

func IsValid

func IsValid(lang string) bool

IsValid checks if the lang code is a known one.

func NativeName

func NativeName(lang Lang) string

Deprecated: use Lang.Native instead.

Types

type Chain

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

Chain helps configuring the chain of fallbacks for a project.

func NewChain

func NewChain(fallbacks ...Lang) Chain

NewChain initializes a new chain.

type Content

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

Content represents a translatable string that can store a different value in each language.

It can be serialized to JSON to send it to a client application. It can also be used with libs.altipla.consulting/rdb.

func NewContent

func NewContent() Content

NewContent returns an empty content without any values.

func NewContentFromMap

func NewContentFromMap(values map[Lang]string) Content

NewContentFromMap builds a new content from a map containing one or multiple values.

func NewContentValue

func NewContentValue(lang Lang, value string) Content

NewContentValue builds a new content with a single translated value.

func ParseContent

func ParseContent(values map[string]string) (Content, error)

ParseContent reads a new content map parsing every language name to check if it's correct. It only returns an error for invalid languages.

func (*Content) Clear

func (content *Content) Clear(lang Lang)

Clear removes a specific language translated value.

func (*Content) ClearAll

func (content *Content) ClearAll()

ClearAll removes all translated values in all languages.

func (Content) Get

func (content Content) Get(lang Lang) string

Get returns the translated value for a language or empty if not present.

func (Content) GetChain

func (content Content) GetChain(chain Chain, lang Lang) string

GetChain does the following steps:

1. Return the content in the requested lang if available. 2. Use the fallback languages if one of them is available. Order is important here. 3. Return any lang available randomly to have something.

If the content is empty it returns an empty string.

func (Content) IsEmpty

func (content Content) IsEmpty() bool

IsEmpty returns if the content does not contains any translated value in any language.

func (Content) Map

func (content Content) Map() map[Lang]string

Map returns a map of every language of the content and its value.

func (Content) MarshalJSON

func (content Content) MarshalJSON() ([]byte, error)

MarshalJSON implements the JSON interface.

func (Content) PlainMap

func (content Content) PlainMap() map[string]string

PlainMap returns a map of every language of the content and its value in a format that can be serialized to protobufs.

func (*Content) Scan

func (content *Content) Scan(value interface{}) error

func (*Content) Set

func (content *Content) Set(lang Lang, value string)

Set changes the translated value of a language. If empty that language will be discarded from the content.

func (*Content) UnmarshalJSON

func (content *Content) UnmarshalJSON(b []byte) error

UnmarshalJSON implements the JSON interface.

func (Content) Value

func (content Content) Value() (driver.Value, error)

type Lang

type Lang struct {
	Code   string
	Native string
	Group  string
}

Lang represents a language

func Parse

func Parse(lang string) (Lang, error)

Parse returns the Lang for a given language.

func (Lang) Empty

func (l Lang) Empty() bool

Empty returns if the lang is empty.

func (Lang) MarshalJSON

func (lang Lang) MarshalJSON() ([]byte, error)

func (Lang) MarshalText

func (lang Lang) MarshalText() ([]byte, error)

func (*Lang) Scan

func (lang *Lang) Scan(src any) error

Scan implements sql.Scanner.

func (Lang) String

func (lang Lang) String() string

String returns the code of the language as string.

func (*Lang) UnmarshalJSON

func (lang *Lang) UnmarshalJSON(b []byte) error

func (*Lang) UnmarshalText

func (lang *Lang) UnmarshalText(text []byte) error

func (Lang) Value

func (lang Lang) Value() (driver.Value, error)

Value implements driver.Valuer.