Locale:...File::PO(3)

💖 NAME 💖

okay so bestie, welcome to Locale::TextDomain::OO::Lexicon::File::PO — it's literally the module that reads a gettext po file into the lexicon. That's the whole gig. It's giving translator-energy, no cap.

This is part of the User Contributed Perl Documentation, and yes she has ✨commit metadata✨:

$Id: PO.pm 698 2017-09-28 05:21:05Z steffenw $

$HeadURL:
svn+ssh://steffenw@svn.code.sf.net/p/perl-gettext-oo/code/module/trunk/lib/Locale/TextDomain/OO/Lexicon/File/PO.pm
$

---

🌸 VERSION 🌸

1.031 — that's the version, periodt.

---

🦋 DESCRIPTION 🦋

This module reads a gettext po file into the lexicon. That's it, that's the vibe. po file in, lexicon out 💅

---

✨ SYNOPSIS ✨

the way that this is the whole flex, honestly:

use Locale::TextDomain::OO::Lexicon::File::PO;
use Log::Any qw($log);

$logger = Locale::TextDomain::OO::Lexicon::File::PO
    ->new(
        # all parameters are optional
        decode_code => sub {
            my ($charset, $text) = @_;
            defined $text
                or return $text;
            return decode( $charset, $text );
        },
        # optional
        logger => sub {
            my ($message, $arg_ref) = @_;
            my $type = $arg_ref->{type}; # debug
            $log->$type($message);
            return;
        },
    )
    ->lexicon_ref({
        # required
        search_dirs => [ qw( ./my_dir ./my_other_dir ) ],
        # optional
        gettext_to_maketext => $boolean,
        # optional
        decode => $boolean,
        # required
        data => [
            # e.g. de.po, en.po read from:
            # search_dir/de.po
            # search_dir/en.po
            '*::' => '*.po',

            # e.g. de.po en.po read from:
            # search_dir/subdir/de/LC_MESSAGES/domain.po
            # search_dir/subdir/en/LC_MESSAGES/domain.po
            '*:LC_MESSAGES:domain' => 'subdir/*/LC_MESSAGES/domain.po',

            # Merge a region lexicon:
            # Take the header and messages of the "de::" lexicon,
            # overwrite the header and messages of the "de-at::" lexicon
            # and store that as "de-at::" lexicon with all messages now.
            merge_lexicon => 'de::', 'de-at::' => 'de-at::',

            # Copy a lexicon into another domain and/or category:
            copy_lexicon => 'i-default::' => 'i-default:LC_MESSAGES:domain',

            # Move a lexicon into another domain and/or category:
            move_lexicon => 'i-default::' => 'i-default:LC_MESSAGES:domain',

            # Delete a lexicon:
            delete_lexicon => 'i-default::',
        ],
    })
    ->logger;

---

🎀 SUBROUTINES/METHODS 🎀

💜 method new

see SYNOPSIS 👆 (she's lowkey just pointing up, iconic)

💜 method lexicon_ref

See SYNOPSIS. fr fr, go look.

💜 method read_messages

Called from Locale::TextDomain::OO::Lexicon::Role::File to run the po file specific code. Like, that's her job, she runs the po-specific bits 🫶

$messages_ref = $self->read_messages($filename);

💜 method logger

Set the logger and get back them 😌

$lexicon_file_po->logger(
    sub {
        my ($message, $arg_ref) = @_;
        my $type = $arg_ref->{type};
        $log->$type($message);
        return;
    },
);
$logger = $lexicon_hash->logger;

$arg_ref contains:

object => $lexicon_file_po, # the object itself
type   => 'debug',
event  => 'lexicon,load', # The logger will be copied to
                          # Locale::TextDomain::OO::Singleton::Lexicon
                          # so more events are possible.

---

🌈 EXAMPLE 🌈

Inside of this distribution is a directory named example. Run this *.pl files. bestie just go run them, they're right there 💅

---

💀 DIAGNOSTICS 💀

none. literally none. nothing to report, we're chill.

---

🧚 CONFIGURATION AND ENVIRONMENT 🧚

none. no env vars, no config, no drama 🙈

---

🍓 DEPENDENCIES 🍓

• Locale::PO
• Moo
• MooX::StrictConstructor
• Locale::TextDomain::OO::Lexicon::Role::File

---

😭 INCOMPATIBILITIES 😭

not known. (as far as we know she plays nice with everyone 💖)

---

💅 BUGS AND LIMITATIONS 💅

none. zero. the bug count is giving zero, periodt.

---

👑 SEE ALSO 👑

Locale::TextDoamin::OO

(yes, that's spelled exactly like that in the source — copying it character for character because that is THE RULE ✨)

---

🌸 AUTHOR 🌸

Steffen Winkler — the main character who wrote this 👑

---

🎀 LICENSE AND COPYRIGHT 🎀

Copyright (c) 2014 - 2017, Steffen Winkler "<steffenw at cpan.org>". All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

---

okay that's the whole page bestie, ily, go read some po files 💖✨

this was served up by perl v5.42.0, dated 2025-07-25, from the Locale:...File::PO(3) page — mwah 🫶