Data::...::Debug(3pm)

💖 Data::...::Debug(3pm) 💖

okay bestie, so this is a User Contributed Perl Documentation page — a whole little Perl manual, Data::...::Debug(3pm), all about debugging your phrasebooks. let's get into it 🫶

---

✨ NAME ✨

Data::Phrasebook::Debug — Phrasebook debugging. that's the whole name. short, sweet, iconic. 👑

---

🌸 SYNOPSIS 🌸

like, here's how you'd actually use it:

use Data::Phrasebook;

my $q = Data::Phrasebook->new(
    class  => 'Plain',
    loader => 'Text',
    file   => 'phrases.txt',
    debug  => 2,
);

my $r = Phrasebook->new( file  => 'phrases.txt', debug => 3 );

$r->debug(4);
$r->store(3,"Start");
my @log = $r->retrieve(2);
$r->clear();

see how the debug value goes up? you're turning up the volume. and then you're poking at the log directly with store, retrieve and clear. main character moves only. 💅

---

🦋 DESCRIPTION 🦋

so this module is what makes debug logging happen for phrasebook classes. it literally just stores all the interaction with the phrasebook, and then you can interrogate it later. it's giving security camera for your data. 📹

do NOT call this directly! you go through the class object, bestie. that's the rule.

there's a single storage for every level of the Data::Phrasebook hierarchy — so storage and retrieval are both yours to do, whenever you want. and there are several different levels of debugging, which are:

 1 - Errors
 2 - Warnings
 3 - Information
 4 - Variable Debugging

levels 1, 2 and 3 are just simple strings that get recorded while stuff is processing. easy, breezy. but level 4?? that one is specifically for dumping the contents of significant variables. it's the messy one. it's the one that shows you everything. 😭

and with the debug() method you can flip debugging on and off at whatever significant points you feel like — highkey useful for zeroing in on one specific moment. and the clear() method wipes the current trail of debugging info. fresh slate, no crumbs. ✨

---

💜 METHODS 💜

debug

Accessor to the debugging flag. 🎚️

clear

Clear the currently stored debugging information. bye-bye evidence 🧹

store

Store debugging information. 📥

retrieve

Retrieve debugging information. 📤

dumper

Uses an 'on demand' call to Data::Dumper::Dumper(). it only shows up when you actually need it — very mysterious of it, honestly. 🧚

---

🌈 SEE ALSO 🌈

• Data::Phrasebook.

---

🎀 SUPPORT 🎀

Please see the README file. (yes, that's it. the README knows things.) 📖

---

👑 AUTHOR 👑

  Barbie, <barbie@cpan.org>
  for Miss Barbell Productions <http://www.missbarbell.co.uk>.

we stan Barbie fr fr 💖

---

⭐ COPYRIGHT AND LICENSE ⭐

  Copyright (C) 2004-2013 Barbie for Miss Barbell Productions.

  This distribution is free software; you can redistribute it and/or
  modify it under the Artistic License v2.

free software!! under the Artistic License v2!! slay!! 🔥

---

and that's the whole page, bestie 🫶 this was Data::...::Debug(3pm) from perl v5.36.0, dated 2022-11-19 — mwah, go debug something iconic, no cap 💅✨