PPIx::...utline(3pm)

🦋 PPIx::EditorTools::Outline 🦋

okay bestie, so this page is literally PPIx::...utline(3pm) — it lives in the User Contributed Perl Documentation section and it's giving "let me peek inside your Perl code and tell you what's in there" energy. ✨

---

🌸 NAME 🌸

PPIx::EditorTools::Outline — Collect use pragmata, modules, subroutiones, methods, attributes 👑

(and yes, subroutiones is spelled exactly like that in here, we don't touch it, it's iconic 💅)

---

🎀 VERSION 🎀

version 0.21 💖

---

✨ SYNOPSIS ✨

no cap, here's the whole vibe:

my $outline = PPIx::EditorTools::Outline->new->find(
      code => "package TestPackage;\nsub x { 1;\n"
    );
print Dumper $outline;

like… it just hands you the tea 🍓

---

💜 DESCRIPTION 💜

Return a list of pragmatas, modules, methods, attributes of a PPI::Document.

that's the whole thing. it takes a PPI::Document and spills all the structural gossip inside it. 🫖✨

---

💅 METHODS 💅

• new() — the Constructor, bestie. Generally shouldn't be called with any arguments. so like… don't. 🙈
• find() — the main character fr fr. here's how you call it:

find( ppi => PPI::Document $ppi )

or

find( code => Str $code )

Accepts either a PPI::Document to process or a string containing the code (which will be converted into a PPI::Document) to process. Return a reference to a hash. that's it, that's the whole flex. 💖

🌈 Internal Methods 🌈

these are the behind-the-scenes girlies, not for you, iykyk:

• _Moo_Attributes
• _Moo_PkgName

---

🔥 SEE ALSO 🔥

This class inherits from PPIx::EditorTools. Also see App::EditorTools, Padre, and PPI. go read those too, they're part of the friend group 🫶

---

👑 AUTHORS 👑

shoutout to the legends who built this, periodt:

• Steffen Mueller smueller@cpan.org
• Mark Grimes mgrimes@cpan.org
• Ahmad M. Zawawi <ahmad.zawawi@gmail.com>
• Gabor Szabo <gabor@szabgab.com>
• Yanick Champoux <yanick@cpan.org>

---

📜 COPYRIGHT AND LICENSE 📜

This software is copyright (c) 2017, 2014, 2012 by The Padre development team as listed in Padre.pm..

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. 🕊️

real talk: that's the standard Perl license deal — free to use, free to remix, same terms as Perl 5 itself. no drama. 💜

---

and that's the whole page, bestie! 💖 this cutie is documented as part of perl v5.34.0, dated 2022-06-17 — tysm for reading, mwah! 🎀✨🦋