archive::any::plugin(3pm) [debian man page]

Archive::Any::Plugin(3pm)				User Contributed Perl Documentation				 Archive::Any::Plugin(3pm)

NAME

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

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;
	    }

AUTHOR

       Clint Moore <cmoore@cpan.org>

SEE ALSO

       Archive::Any

perl v5.10.0							    2008-06-25						 Archive::Any::Plugin(3pm)

Archive::Any(3pm)					User Contributed Perl Documentation					 Archive::Any(3pm)

NAME

       Archive::Any - Single interface to deal with file archives.

SYNOPSIS

	 use Archive::Any;

	 my $archive = Archive::Any->new($archive_file);

	 my @files = $archive->files;

	 $archive->extract;

	 my $type = $archive->type;

	 $archive->is_impolite;
	 $archive->is_naughty;

DESCRIPTION

       This module is a single interface for manipulating different archive formats.  Tarballs, zip files, etc.

       new
	     my $archive = Archive::Any->new($archive_file);
	     my $archive = Archive::Any->new($archive_file, $type);

	   $type is optional.  It lets you force the file type in-case Archive::Any can't figure it out.

       extract
	     $archive->extract;
	     $archive->extract($directory);

	   Extracts the files in the archive to the given $directory.  If no $directory is given, it will go into the current working directory.

       files
	     my @file = $archive->files;

	   A list of files in the archive.

       mime_type
	    my $mime_type = $archive->mime_type();

	   Returns the mime type of the archive.

       is_impolite
	     my $is_impolite = $archive->is_impolite;

	   Checks to see if this archive is going to unpack into the current directory rather than create its own.

       is_naughty
	     my $is_naughty = $archive->is_naughty;

	   Checks to see if this archive is going to unpack outside the current directory.

DEPRECATED

       type
	     my $type = $archive->type;

	   Returns the type of archive.  This method is provided for backwards compatibility in the Tar and Zip plugins and will be going away
	   soon in favor of "mime_type".

PLUGINS

       For detailed information on writing plugins to work with Archive::Any, please see the pod documentation for Archive::Any::Plugin.

AUTHOR

       Clint Moore <cmoore@cpan.org>

AUTHOR EMERITUS

       Michael G Schwern

SEE ALSO

       Archive::Any::Plugin

SUPPORT

       You can find documentation for this module with the perldoc command.

	perldoc Archive::Any

       You can also look for information at:

       o   AnnoCPAN: Annotated CPAN documentation

	   <http://annocpan.org/dist/Archive-Any>

       o   CPAN Ratings

	   <http://cpanratings.perl.org/d/Archive-Any>

       o   RT: CPAN's request tracker

	   <http://rt.cpan.org/NoAuth/Bugs.html?Dist=Archive-Any>

       o   Search CPAN

	   <http://search.cpan.org/dist/Archive-Any>

LICENSE

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

       See <http://www.perl.com/perl/misc/Artistic.html>

perl v5.10.0							    2008-06-25							 Archive::Any(3pm)