.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Log::Report::Translator 3pm"
.TH Log::Report::Translator 3pm "2023-10-29" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Log::Report::Translator \- base implementation for translating messages
.SH "INHERITANCE"
.IX Header "INHERITANCE"
.Vb 3
\& Log::Report::Translator is extended by
\&   Log::Report::Translator::Gettext
\&   Log::Report::Translator::POT
.Ve
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\& # internal infrastructure
\& my $msg = Log::Report::Message\->new(_msgid => "Hello World\en");
\& print Log::Report::Translator\->new(...)\->translate($msg);
\&
\& # normal use
\& textdomain \*(Aqmy\-domain\*(Aq
\&   , translator => Log::Report::Translator\->new;  # default
\& print _\|_"Hello World\en";
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A module (or distribution) has a certain way of translating messages,
usually \f(CW\*(C`gettext\*(C'\fR.  The translator is based on some \f(CW\*(C`textdomain\*(C'\fR
for the message, which can be specified as option per text element,
but usually is package scoped.
.PP
This base class does not translate at all: it will use the \s-1MSGID\s0
(and \s-1MSGID_PLURAL\s0 if available).  It's a nice fallback if the
language packs are not installed.
.SH "METHODS"
.IX Header "METHODS"
.SS "Constructors"
.IX Subsection "Constructors"
.IP "Log::Report::Translator\->\fBnew\fR(%options)" 4
.IX Item "Log::Report::Translator->new(%options)"
.SS "Accessors"
.IX Subsection "Accessors"
.SS "Translating"
.IX Subsection "Translating"
.PD 0
.ie n .IP "$obj\->\fBload\fR($domain, $locale)" 4
.el .IP "\f(CW$obj\fR\->\fBload\fR($domain, \f(CW$locale\fR)" 4
.IX Item "$obj->load($domain, $locale)"
.PD
Load the translation information in the text \f(CW$domain\fR for the indicated \f(CW$locale\fR.
Multiple calls to \fBload()\fR should not cost significant performance: the
data must be cached.
.ie n .IP "$obj\->\fBtranslate\fR( $message, [$language, $ctxt] )" 4
.el .IP "\f(CW$obj\fR\->\fBtranslate\fR( \f(CW$message\fR, [$language, \f(CW$ctxt\fR] )" 4
.IX Item "$obj->translate( $message, [$language, $ctxt] )"
Returns the translation of the \f(CW$message\fR, a \f(CW\*(C`Log::Report::Message\*(C'\fR object,
based on the current locale.
.Sp
Translators are permitted to peek into the internal \s-1HASH\s0 of the
message object, for performance reasons.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
This module is part of Log-Report distribution version 1.36,
built on October 27, 2023. Website: \fIhttp://perl.overmeer.net/CPAN/\fR
.SH "LICENSE"
.IX Header "LICENSE"
Copyrights 2007\-2023 by [Mark Overmeer <markov@cpan.org>]. For other contributors see ChangeLog.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See \fIhttp://dev.perl.org/licenses/\fR