Ivan Tubert-Brohman > AnnoCPAN-0.22 > AnnoCPAN::Archive

Download:
AnnoCPAN-0.22.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  16
Open  6
View/Report Bugs
Module Version: 0.22   Source  

NAME ^

AnnoCPAN::Archive - Simple archive abstraction layer

SYNOPSIS ^

DESCRIPTION ^

AnnoCPAN is expected to handle both tar.gz and zip archives. Archive::Tar and Archive::Zip take care of accessing those types of files, but they have different interfaces. AnnoCPAN::Archive provides a common interface to the very few methods that are actually needed.

METHODS ^

$class->new($fname)

Create a new AnnoCPAN::Archive object. It uses the filename extension, which must be .zip or .tar.gz, to determine the type of archive. Returns undefined if there is any problem.

$obj->files

Returns a list of the filenames contained in the archive.

$obj->read_file($fname)

Returns as a string the contents of file $fname in the archive.

SEE ALSO ^

Archive::Tar, Archive::Zip

There are other modules on CPAN, such as Archive::Any, Archive::Extract, and File::Archive, that seem to do similar things, but they didn't appear to do exactly what I wanted or seemed too complicated, so I resorted to rolling my own. It was just a dozen lines of code (heck, this documentation is way longer than the code itself!)

AUTHOR ^

Ivan Tubert-Brohman <itub@cpan.org>

COPYRIGHT ^

Copyright (c) 2005 Ivan Tubert-Brohman. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: