Archive-Zip-Parser version 0.0.3

NAME
    Archive::Zip::Parser - Parser for .ZIP archives

VERSION
    This document describes Archive::Zip::Parser version 0.0.3

INSTALLATION

To install this module, run the following commands:

        perl Build.PL
        ./Build
        ./Build test
        ./Build install

SYNOPSIS
        use Archive::Zip::Parser;

        my $parser
          = Archive::Zip::Parser->new( { file_name => 'secret_files.zip' } );
        $parser->parse();

DESCRIPTION
    This parser is based on the specifications stated in APPNOTE.TXT
    (<http://www.pkware.com/documents/casestudies/APPNOTE.TXT>) version
    6.3.2 published by PKWARE, Inc.

INTERFACE
    "new( { file_name => VALUE } )"
        "file_name" - File name with path to .ZIP archive

        Returns a parser object.

    "verify_signature()"
        Returns true if the file is a valid .ZIP archive. Else returns
        false.

    "parse()"
        Parses file if it has not already been parsed. Dies if not a valid
        .ZIP archive.

    "get_entry()"
        Returns a list of entry objects.

    "get_entry(VALUE)"
        Returns particular entry object.

    "get_central_directory_end()"
        Returns central directory end object.

DIAGNOSTICS
    "Missing "file_name""
        Reported when argument "file_name" is not provided to "new()".

    "Not a valid .ZIP archive"
        This error is reported when dying due to parsing an invalid .ZIP
        archive.

CONFIGURATION AND ENVIRONMENT
    Archive::Zip::Parser requires no configuration files or environment
    variables.

DEPENDENCIES
    autodie
        First released with perl 5.010001

    Carp
        First released with perl 5

    Data::ParseBinary
        Not in CORE

    version
        First released with perl 5.009

INCOMPATIBILITIES
    None reported.

BUGS AND LIMITATIONS
    No bugs have been reported.

    Please report any bugs or feature requests to
    "bug-archive-zip-parser@rt.cpan.org", or through the web interface at
    <http://rt.cpan.org>.

AUTHOR
    Alan Haggai Alavi "<haggai@cpan.org>"

ACKNOWLEDGEMENTS
    Thanks to Shain Padmajan (<http://shain.co.in/>) for helping me shorten
    method names.

SEE ALSO
    *   Archive::Zip::Parser::CentralDirectoryEnd

    *   Archive::Zip::Parser::Entry

    *   Archive::Zip::Parser::Entry::CentralDirectory

    *   Archive::Zip::Parser::Entry::DataDescriptor

    *   Archive::Zip::Parser::Entry::LocalFileHeader

LICENCE AND COPYRIGHT
    Copyright (c) 2010, Alan Haggai Alavi "<haggai@cpan.org>". All rights
    reserved.

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

DISCLAIMER OF WARRANTY
    BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
    FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
    OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
    PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
    EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
    WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
    ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
    YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
    NECESSARY SERVICING, REPAIR, OR CORRECTION.

    IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
    WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
    REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE
    TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR
    CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
    SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
    RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
    FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
    SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
    DAMAGES.
