gettext v0.16.1 Gettext.Backend behaviour View Source

Behaviour that defines the macros that a Gettext backend has to implement.

Link to this section Summary

Callbacks

Same as dgettext(domain, msgid, %{})

Translates the given msgid in the given domain

Marks the given translation for extraction and returns it unchanged

Same as dngettext(domain, msgid, msgid_plural, n, %{})

Translates the given plural translation (msgid + msgid_plural) in the given domain

Marks the given translation for extraction and returns {msgid, msgid_plural}

Same as gettext(msgid, %{})

Same as dgettext("default", msgid, %{})

Stores an “extracted comment” for the next translation

Same as dgettext_noop("default", msgid)

Default handling for missing bindings

Default handling for plural translations with a missing translation

Default handling for translations with a missing translation

Same as ngettext(msgid, msgid_plural, n, %{})

Same as dngettext("default", msgid, msgid_plural, n, bindings)

Same as dngettext_noop("default", msgid, mgsid_plural)

Link to this section Callbacks

Link to this macrocallback dgettext(domain, msgid) View Source
dgettext(term(), domain :: Macro.t(), msgid :: String.t()) :: Macro.t()

Same as dgettext(domain, msgid, %{}).

See also Gettext.dgettext/4.

Link to this macrocallback dgettext(domain, msgid, bindings) View Source
dgettext(
  term(),
  domain :: Macro.t(),
  msgid :: String.t(),
  bindings :: Macro.t()
) :: Macro.t()

Translates the given msgid in the given domain.

bindings is a map of bindings to support interpolation.

See also Gettext.dgettext/4.

Link to this macrocallback dgettext_noop(domain, msgid) View Source
dgettext_noop(term(), domain :: String.t(), msgid :: String.t()) :: Macro.t()

Marks the given translation for extraction and returns it unchanged.

This macro can be used to mark a translation for extraction when mix gettext.extract is run. The return value is the given string, so that this macro can be used seamlessly in place of the string to extract.

Examples

MyApp.Gettext.dgettext_noop("errors", "Error found!")
#=> "Error found!"
Link to this macrocallback dngettext(domain, msgid, msgid_plural, n) View Source
dngettext(
  term(),
  domain :: Macro.t(),
  msgid :: String.t(),
  msgid_plural :: String.t(),
  n :: Macro.t()
) :: Macro.t()

Same as dngettext(domain, msgid, msgid_plural, n, %{}).

See also Gettext.dngettext/6.

Link to this macrocallback dngettext(domain, msgid, msgid_plural, n, bindings) View Source
dngettext(
  term(),
  domain :: Macro.t(),
  msgid :: String.t(),
  msgid_plural :: String.t(),
  n :: Macro.t(),
  bindings :: Macro.t()
) :: Macro.t()

Translates the given plural translation (msgid + msgid_plural) in the given domain.

n is an integer used to determine how to pluralize the translation. bindings is a map of bindings to support interpolation.

See also Gettext.dngettext/6.

Link to this macrocallback dngettext_noop(domain, msgid, msgid_plural) View Source
dngettext_noop(
  term(),
  domain :: Macro.t(),
  msgid :: String.t(),
  msgid_plural :: String.t()
) :: Macro.t()

Marks the given translation for extraction and returns {msgid, msgid_plural}.

This macro can be used to mark a translation for extraction when mix gettext.extract is run. The return value of this macro is {msgid, msgid_plural}.

Examples

my_fun = fn {msgid, msgid_plural} ->
  # do something with msgid and msgid_plural
end

my_fun.(MyApp.Gettext.dngettext_noop("errors", "One error", "%{count} errors"))
Link to this macrocallback gettext(msgid) View Source
gettext(term(), msgid :: String.t()) :: Macro.t()

Same as gettext(msgid, %{}).

See also Gettext.gettext/3.

Link to this macrocallback gettext(msgid, bindings) View Source
gettext(term(), msgid :: String.t(), bindings :: Macro.t()) :: Macro.t()

Same as dgettext("default", msgid, %{}).

See also Gettext.gettext/3.

Link to this macrocallback gettext_comment(comment) View Source
gettext_comment(term(), comment :: String.t()) :: :ok

Stores an “extracted comment” for the next translation.

This macro can be used to add comments (Gettext refers to such comments as extracted comments) to the next translation that will be extracted. Extracted comments will be prefixed with #. in POT files.

Calling this function multiple times will accumulate the comments; when another Gettext macro (such as gettext/2) is called, the comments will be extracted and attached to that translation, and they will be flushed so as to start again.

This macro always returns :ok.

Examples

MyApp.Gettext.gettext_comment("The next translation is awesome")
MyApp.Gettext.gettext_comment("Another comment for the next translation")
MyApp.Gettext.gettext("The awesome translation")
Link to this macrocallback gettext_noop(msgid) View Source
gettext_noop(term(), msgid :: String.t()) :: Macro.t()

Same as dgettext_noop("default", msgid).

Link to this callback handle_missing_bindings(arg0, binary) View Source
handle_missing_bindings(Gettext.MissingBindingsError.t(), binary()) ::
  binary() | no_return()

Default handling for missing bindings.

This function is called when there are missing bindings in a translation. It takes a Gettext.MissingBindingsError struct and the translation with the wrong bindings left as is with the %{} syntax.

For example, if something like this is called:

MyApp.Gettext.gettext("Hello %{name}, welcome to %{country}", name: "Jane", country: "Italy")

and our it/LC_MESSAGES/default.po looks like this:

msgid "Hello %{name}, welcome to %{country}"
msgstr "Ciao %{name}, benvenuto in %{cowntry}" # (typo)

then Gettext will call:

MyApp.Gettext.handle_missing_bindings(exception, "Ciao Jane, benvenuto in %{cowntry}")

where exception is a struct that looks like this:

%Gettext.MissingBindingsError{
  backend: MyApp.Gettext,
  domain: "default",
  locale: "it",
  msgid: "Hello %{name}, welcome to %{country}",
  bindings: [:country],
}

The return value of the handle_missing_bindings/2 callback is used as the translated string that the translation macros and functions return.

The default implementation for this function uses Logger.error/1 to warn about the missing binding and returns the translated message with the incomplete bindings.

This function can be overridden. For example, to raise when there are missing bindings:

def handle_missing_bindings(exception, _incomplete) do
  raise exception
end
Link to this callback handle_missing_plural_translation(arg0, domain, msgid, msgid_plural, n, bindings) View Source
handle_missing_plural_translation(
  Gettext.locale(),
  domain :: String.t(),
  msgid :: String.t(),
  msgid_plural :: String.t(),
  n :: non_neg_integer(),
  bindings :: map()
) :: {:ok | :default, String.t()}

Default handling for plural translations with a missing translation.

Same as handle_missing_translation/4, but for plural translations. In this case, n is the number used for pluralizing the translated string.

Link to this callback handle_missing_translation(arg0, domain, msgid, bindings) View Source
handle_missing_translation(
  Gettext.locale(),
  domain :: String.t(),
  msgid :: String.t(),
  bindings :: map()
) :: {:ok | :default, String.t()}

Default handling for translations with a missing translation.

When a Gettext function/macro is called with a string to translate into a locale but that locale doesn’t provide a translation for that string, this callback is invoked. msgid is the string that Gettext tried to translate.

This function should return {:ok, translated} if a translation can be fetched or constructed for the given string, or {:default, msgid} otherwise.

Link to this macrocallback ngettext(msgid, msgid_plural, n) View Source
ngettext(
  term(),
  msgid :: String.t(),
  msgid_plural :: String.t(),
  n :: Macro.t()
) :: Macro.t()

Same as ngettext(msgid, msgid_plural, n, %{}).

See also Gettext.ngettext/5.

Link to this macrocallback ngettext(msgid, msgid_plural, n, bindings) View Source
ngettext(
  term(),
  msgid :: String.t(),
  msgid_plural :: String.t(),
  n :: Macro.t(),
  bindings :: Macro.t()
) :: Macro.t()

Same as dngettext("default", msgid, msgid_plural, n, bindings).

See also Gettext.ngettext/5.

Link to this macrocallback ngettext_noop(msgid, msgid_plural) View Source
ngettext_noop(term(), msgid :: String.t(), msgid_plural :: String.t()) ::
  Macro.t()

Same as dngettext_noop("default", msgid, mgsid_plural).