magazinesdotcom / cpan-packages Goto Github PK

NAME
    CPAN::Packages - OO Interface to 02packages.details.txt.gz

SYNOPSIS
      my $pks = CPAN::Packages->new(file => 't/data/02packages.details.txt.gz');

      $pks->get_header('Columns'); # or whatever

      my $ach = $pks->get_package('ACH');
      print $ach->{'package name'}."\n";
      print $ach->{version}->stringify."\n"; version.pm version
      print $ach->{path}."\n";

      $pks->write_file; # XX not implemented yet

ATTRIBUTES
  file
    The name of the file we are parsing. Should be a path to a gzipped
    version of CPAN's 02packages file, since that's what this whole module
    is for.

  header
    The header information for the packages file.

  packages
    Returns a hashref of packages, where the key XX

METHODS
  as_string
    Return this listing of packages as a string, suitable for printing as a
    file.

  get_columns_as_list
    Returns the columns that are in this packages file (as specified by the
    Columns header) as a list of strings. Note that you must have set this
    first via "set_header" or a file read.

  get_header ($name)
    Get the value of the specified header.

  get_package ($name)
    Get a hashref of info about a package.

  header_names
    Get a list of headers.

  package_names
    Get a list of package names.

  set_header ($name, $value)
    Set the header to the specified value.

  set_package ($name, \%val)
    Set a package's info.

AUTHOR
    Cory G Watson, "<gphat at cpan.org>"

ACKNOWLEDGEMENTS
COPYRIGHT & LICENSE
    Copyright 2010 Cory G Watson.

    This program is free software; you can redistribute it and/or modify it
    under the terms of either: the GNU General Public License as published
    by the Free Software Foundation; or the Artistic License.

    See http://dev.perl.org/licenses/ for more information.