.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "Log::Report::Translator 3"
.TH Log::Report::Translator 3 2025-12-12 "perl v5.42.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 MSGID
(and MSGID_PLURAL if available).  It\*(Aqs a nice fallback if the
language packs are not installed.
.SH METHODS
.IX Header "METHODS"
.SS Constructors
.IX Subsection "Constructors"
.ie n .IP $class\->\fBnew\fR(%options) 4
.el .IP \f(CW$class\fR\->\fBnew\fR(%options) 4
.IX Item "$class->new(%options)"

.SS Accessors
.IX Subsection "Accessors"
.SS Translating
.IX Subsection "Translating"
.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)"
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 Log::Report::Message object,
based on the current locale.
.Sp
Translators are permitted to peek into the internal HASH of the
message object, for performance reasons.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
This module is part of Log\-Report version 1.43,
built on December 05, 2025. Website: \fIhttp://perl.overmeer.net/CPAN/\fR
.SH LICENSE
.IX Header "LICENSE"
For contributors see file ChangeLog.
.PP
This software is copyright (c) 2007\-2025 by Mark Overmeer.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.