Log::R...xtract(3pm)

💖 Log::R...xtract(3pm) 💖

okay bestie, welcome to the Log::R...xtract(3pm) manual page — straight out of the User Contributed Perl Documentation vault ✨. It's a Perl module and it's lowkey a whole vibe if you're into translation tooling, which you're about to be 🫶

---

🌸 NAME 🌸

Log::Report::Extract — collecting translatable strings, one message-id at a time 💅

---

🦋 INHERITANCE 🦋

Log::Report::Extract gets extended by these iconic children:

• Log::Report::Extract::PerlPPI
• Log::Report::Template::Extract

like it's giving proud parent energy fr fr 👑

---

✨ SYNOPSIS ✨

# See the extensions

that's it, that's the synopsis. the extensions said "iykyk" 🙈

---

💜 DESCRIPTION 💜

so here's the tea, bestie 🍓: this module is the one that helps you maintain your POT files — aka it keeps that list of message-ids inside them all fresh and up to date ✨.

after initiation, you gotta call the process() method with literally every file that changed since the last time you processed. once you do that, the existing PO files get updated accordingly, no cap 🔥.

and if there are no translations yet? don't even stress — one textdomain/xx.po file will be created for you 💅 iconic behavior honestly.

---

🎀 METHODS 🎀

🌈 Constructors

$class->new(%options)

here's the options table, vibe check it:

• Option — Default
• charset — 'utf-8'
• lexicon — <required>
• charset => STRING — the character-set used in the PO files ✨
• lexicon => DIRECTORY — the place where the lexicon is kept. and when no lexicon is defined yet, THIS is the directory where a domain/xx.po file will be created 🫶

---

🌸 Accessors

• $obj->addPot($domain, $pot, %options) — adds a POT, bestie 💖
• $obj->charset() — returns the character-set that's used inside the POT files ✨
• $obj->domains() — returns a sorted list of all known domain names 🗂️
• $obj->index() — returns the Log::Report::Lexicon::Index object, which is the one listing the files in the lexicon directory tree 🌳
• $obj->pots($domain) — returns the list of Log::Report::Lexicon::POT objects which contain the tables for $domain 👑

---

🧚 Processors

• $obj->cleanup(%options) — remove all references. like, all of them 🧹

here's the options table:

• Option — Default
• keep — []
• keep => HASH|ARRAY — keep the information about these filename, either specified as an ARRAY of names, or a HASH where the keys are the named 👀

• $obj->process($filename, %options) — update the domains mentioned in $filename. all text-domains defined in the file will get updated automatically, but heads up bestie ⚠️: they should not be written before all files are processed. what you get back is the number of messages found in this particular file 🔢
• $obj->showStats([$domains]) — show a status about the DOMAIN (and by default, all domains). at least mode verbose is required to see this, so don't come crying if it's quiet 😭

the statistics are sent to (Log::Report) dispatchers which accept notice and info. this could be syslog 👾. and when you have no explicit dispatchers in your program, the level of detail gets controlled by the 'mode':

use Log::Report mode => 'DEBUG';  # or 'VERBOSE'

• $obj->store( $domain, $filename, $linenr, $context, $msg, [$msg_plural] ) — register the existence of a ($msg, $msg_plural) in all POTs of the $domain 📝
• $obj->write( [$domain], %options ) — update the information of the files related to $domain, and by default that means all processed DOMAINS 💅

all information known about the written $domain is removed from the cache (poof 💨). and the %options get passed straight to the write() of the specific lexicon manager 🫶

---

💀 DIAGNOSTICS 💀

• Fault: cannot create lexicon directory $dir: $!

Cast by new()

• Error: extractions require an explicit lexicon directory

Cast by new()

• Error: no context tags allowed in plural `$msgid'

Cast by store()

• Info: starting new textdomain $domain, template in $filename

Cast by write()

---

👑 SEE ALSO 👑

this module is part of Log-Report-Lexicon version 1.15, built on November 06, 2025 ⭐. Website: http://perl.overmeer.net/CPAN/ 🌈

---

🎀 LICENSE 🎀

for contributors see file ChangeLog 📓

this software is copyright (c) 2007-2025 by Mark Overmeer 💖

this is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself — slay, go forth and redistribute periodt 💅

---

and that's a wrap, bestie 🦋 this little edition ran on perl v5.40.1, dated 2025-11-11, and you read the Log::R...xtract(3pm) page top to bottom like a true main character 👑💖 mwah, go collect those strings ✨