DUPUIS Arnaud > Slackware-Slackget > Slackware::Slackget::SpecialFiles::FILELIST

Download:
Slackware-Slackget-0.17.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  1
View/Report Bugs
Module Version: 1.0.0   Source  

NAME ^

Slackware::Slackget::SpecialFiles::FILELIST - An interface for the special file FILELIST.TXT

VERSION ^

Version 1.0.0

SYNOPSIS ^

This class contain all methods for the treatment of the FILELIST.TXT file

    use Slackware::Slackget::SpecialFiles::FILELIST;

    my $spec_file = Slackware::Slackget::SpecialFiles::FILELIST->new('FILELIST.TXT');
    $spec_file->compil();
    my $ref = $spec_file->get_file_list() ;

This class care about package-namespace, which is the root set of a package (slackware, extra or pasture for packages from Slackware)

WARNINGS ^

All classes from the Slackware::Slackget::SpecialFiles:: namespace need the followings methods :

        - a contructor new()
        - a method compil()
        - a method get_result(), which one can be an alias on another method of the class.

Moreover, the get_result() methode need to return a hashref. Keys of this hashref are the filenames.

Classes from ths namespace represent an abstraction of the special file they can manage so informations stored in the returned hashref must have a direct link with this special file.

CONSTRUCTOR ^

new

Take a file, a Slackware::Slackget::Config object and an id name :

        my $spec_chk = Slackware::Slackget::SpecialFiles::CHECKSUMS->new('/home/packages/FILELIST.TXT',$config,'slackware');

The constructor return undef if the file does not exist.

FUNCTIONS ^

compile

This method take no arguments, and extract the list of couple (file/package-namespace). Those couple are store into an internal data structure.

        $list->compile();

get_file_list

Return a hashref build on this model

        $ref = {
                filename => Slackware::Slackget::Package
        }

        my $ref = $list->get_file_list ;

get_package

Return informations relative to a packages as a hashref.

        my $hashref = $list->get_package($package_name) ;

get_result

Alias for get_file_list().

get_date

return a Slackware::Slackget::Date object, which is the date of the FILELIST.TXT

        my $date = $list->get_date ;

to_XML (deprecated)

Same as to_xml(), provided for backward compatibility.

to_xml

return a string containing all packages name carriage return separated.

WARNING: ONLY FOR DEBUG

        my $string = $list->to_xml();

meta_to_XML (deprecated)

Same as meta_to_xml(), provided for backward compatibility.

meta_to_xml

Return an XML encoded string which represent the meta informations of the FILELIST.TXT file.

        my $xml_string = $list->meta_to_xml ;

AUTHOR ^

DUPUIS Arnaud, <a.dupuis@infinityperl.org>

BUGS ^

Please report any bugs or feature requests to bug-Slackware-Slackget@rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Slackware-Slackget. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT ^

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

    perldoc Slackware::Slackget

You can also look for information at:

ACKNOWLEDGEMENTS ^

Thanks to Bertrand Dupuis (yes my brother) for his contribution to the documentation.

COPYRIGHT & LICENSE ^

Copyright 2005 DUPUIS Arnaud, 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: