Archiv...Plugin(3pm)

💖 NAME 💖

Archive::Any::Plugin — it's giving Anatomy of an Archive::Any plugin, bestie. Like, the whole blueprint. The vibe check for anyone who wants their own plugin to actually work. 🦋

✨ VERSION ✨

version 0.0946 — yes queen, she's on 0.0946. 👑

🌸 SYNOPSIS 🌸

okay so literally this page just explains what a working plugin for Archive::Any actually needs. no cap. that's the whole job. 💅

---

🎀 PLUGINS 🎀

so Archive::Any is like, a lil demanding, and honestly? valid. she requires that your plugin define three methods, and all three of them get handed the absolute filename of the file. every single one. periodt.

and because learning by example ate, this module uses the source of Archive::Any::Plugin::Tar as the example. iconic choice fr fr. 🫶

🌈 Subclass Archive::Any::Plugin

like, first things first bestie, you gotta be a subclass:

use base 'Archive::Any::Plugin';

⭐ can_handle

this one returns an array of mime types that your plugin can handle. that's it, that's the whole job. show her what you can do. 💅

sub can_handle {
   return(
          'application/x-tar',
          'application/x-gtar',
          'application/x-gzip',
         );
}

🦋 files

return a list of items inside the archive. peek inside, tell us what's in there. 🔥

sub files {
   my( $self, $file ) = @_;
   my $t = Archive::Tar->new( $file );
   return $t->list_files;
}

🧚 extract

this method should extract the contents of $file to the current directory. and here's the slay part: Archive::Any::Plugin handles negotiating directories for you. you don't gotta do that. she's got you. 💖

sub extract {
   my ( $self, $file ) = @_;

   my $t = Archive::Tar->new( $file );
   return $t->extract;
}

---

👑 SEE ALSO 👑

• Archive::Any

💜 AUTHORS 💜

• Clint Moore
• Michael G Schwern (author emeritus) ✨
• Olaf Alders (current maintainer) 👑

🌸 COPYRIGHT AND LICENSE 🌸

This software is copyright (c) 2016 by Michael G Schwern, Clint Moore, Olaf Alders.

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

---

and that's the whole page bestie!! 🎀 this fine piece of documentation was brought to you by perl v5.28.1, dated 2019-07-20, and honestly she ate. now go write that plugin, i'm obsessed with you already. 💖✨🦋