---
name: "Archive::Any::Plugin"
section: "3pm"
platform: "linux"
package: "libarchive-any-perl"
version: "0.0946-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/Archive::Any::Plugin"
---

# Archive::Any::Plugin(3pm)

Anatomy of an Archive::Any plugin.

## NAME

Archive::Any::Plugin - Anatomy of an Archive::Any plugin.

## VERSION

version 0.0946

## SYNOPSIS

Explains what is required for a working plugin to Archive::Any.

## PLUGINS

Archive::Any requires that your plugin define three methods, all of which are passed the absolute filename of the file.  This module uses the source of Archive::Any::Plugin::Tar as an example.

- **Subclass Archive::Any::Plugin**

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

- **can\_handle**

  This returns an array of mime types that the plugin can handle.

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

- **files**

  Return a list of items inside the archive.

  ```
   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. Archive::Any::Plugin handles negotiating directories for 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.