NAME

Log::Report::Translator::POT - translation based on POT files

INHERITANCE

 Log::Report::Translator::POT
   is a Log::Report::Translator

SYNOPSIS

 # internal use
 my $msg = Log::Report::Message->new
   ( _msgid  => "Hello World\n"
   , _domain => 'my-domain'
   );

 print Log::Report::Translator::POT
    ->new(lexicon => $dir)
    ->translate($msg, 'nl-BE');

 # normal use (end-users view in the program's ::main)
 textdomain 'my-domain'
   , translator =>  Log::Report::Translator::POT->new(lexicon => $dir);
 print __"Hello World\n";

DESCRIPTION

Translate a message by directly accessing POT files. The files will load lazily (unless forced). This module accesses the PO's in a compact way, using Log::Report::Lexicon::POTcompact, which is much more efficient than Log::Report::Lexicon::PO.

Extends "DESCRIPTION" in Log::Report::Translator.

METHODS

Extends "METHODS" in Log::Report::Translator.

Constructors

Extends "Constructors" in Log::Report::Translator.

Log::Report::Translator::POT->new(%options)
 -Option  --Default
  charset   <undef>
  lexicons  <see text>
charset => STRING

Enforce character set for files. We default to reading the character-set as defined in the header of each PO file.

lexicons => DIRECTORY

The DIRECTORY where the translations can be found. See Log::Report::Lexicon::Index for the expected structure of such DIRECTORY.

The default is based on the location of the module which instantiates this translator. The filename of the module is stripped from its .pm extension, and used as directory name. Within that directory, there must be a directory named messages, which will be the root directory of a Log::Report::Lexicon::Index.

example: default lexicon directory

 # file xxx/perl5.8.8/My/Module.pm
 use Log::Report 'my-domain'
   , translator => Log::Report::Translator::POT->new;

 # lexicon now in xxx/perl5.8.8/My/Module/messages/

Accessors

Extends "Accessors" in Log::Report::Translator.

$obj->charset()

Returns the default charset, which can be overrule by the locale.

$obj->lexicons()

Returns a list of Log::Report::Lexicon::Index objects, where the translation files may be located.

Translating

Extends "Translating" in Log::Report::Translator.

$obj->load($domain, $locale)

Inherited, see "Translating" in Log::Report::Translator

$obj->translate( $message, [$language, $ctxt] )

Inherited, see "Translating" in Log::Report::Translator

SEE ALSO

This module is part of Log-Report-Lexicon distribution version 1.11, built on March 22, 2018. Website: http://perl.overmeer.net/CPAN/

LICENSE

Copyrights 2007-2018 by [Mark Overmeer <markov@cpan.org>]. For other contributors see ChangeLog.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See http://dev.perl.org/licenses/