Text::...Warning(3pm)

💖 Text::...Warning(3pm) — Text::BibTeX::Validate::Warning 💖

okay bestie, so this page lives in the User Contributed Perl Documentation manual, and it's all about the validaton warning class. yes. we're doing warnings. but like, ✨structured✨ warnings.

---

🌸 NAME 🌸

Text::BibTeX::Validate::Warning — the validaton warning class 🎀

---

✨ SYNOPSIS ✨

use Text::BibTeX::Validate::Warning;

my $warning = Text::BibTeX::Validate::Warning->new(
    'value \'%(value)s\' is better written as \'%(suggestion)s\'',
    {
        field => 'month',
        value => '1',
        suggestion => 'Jan',
    }
);
print STDERR "$warning\n";

look at her go 😌💅

---

🦋 DESCRIPTION 🦋

so like, Text::BibTeX::Validate::Warning is the little container where the content of a validation warning lives — the ones emitted by Text::BibTeX::Validate — except it stores them in a structured way instead of just being a sad little string. no cap.

and because she's a class with manners, overloads are defined so you can stringify her and compare instances of the class. she's giving main character energy, fr fr. 🔥

---

👑 METHODS 👑

💜 new( $message, $fields )

okay so this one takes a Text::sprintfn-compatible template and a hash holding the values for replacement in that template. 🫶

and listen — three field names are reserved and get used as prefixes for messages if they're defined:

• file — the name of a file 📁
• key — the BibTeX key 🔑
• field — the BibTeX field name 🏷️

also, the field suggestion is somewhat special too, because Text::BibTeX::Validate may use its value to replace the original in an attempt to clean up the BibTeX entry. she's a fixer. she's an icon. she's doing the work. 💖

---

🌈 fields()

returns an array of the fields defined in the instance — in any order, so don't come for her about the order, bestie. 🙈

---

🍓 get( $field )

returns the value of a field. that's it. that's the method. simple, iconic, ate. ⭐

---

💅 set( $field, $value )

sets a new value for a field. and then — plot twist — she returns the old value. 😭 so rude but so useful.

---

🧚 delete( $field )

unsets the value for a field. and yup, returns the old value too, because she would never leave you without closure. 💜

---

🌟 to_string()

return a string representing the warning. literally just that. stringify slay. ✨

---

🎀 AUTHORS 🎀

• Andrius Merkys, <merkys@cpan.org> 👑

---

💖 and that's the whole vibe check, bestie. every flag, every field, every method, nothing skipped, periodt. 🦋

---

okay so this lil doc came from perl v5.32.1, dated 2021-02-28, and it lives in the User Contributed Perl Documentation family 💖 mwah, go validate some BibTeX, you've got this 🫶✨🌈