1Parse::CPAN::DistributiUosnesr(3C)ontributed Perl DocumePnatrastei:o:nCPAN::Distributions(3)
2
3
4
6 Parse::CPAN::Distributions - Provides an index for current CPAN
7 distributions
8
10 my $oncpan = Parse::CPAN::Distributions->new(database => $db);
11 my $found = $oncpan->listed($distribution,$version);
12 my $any = $oncpan->listed($distribution);
13 my @dists = $oncpan->distributions_by($author);
14 my $author = $oncpan->author_of($distribution,$version);
15 my $version = $oncpan->latest_version($distribution);
16 my @versions = $oncpan->versions($distribution);
17
19 This distribution provides the ability to index the distributions that
20 are currently listed on CPAN. This is done by parsing the index file
21 find-ls.
22
24 The Constructor
25 new Parses find-ls, extracting the list of all the module
26 distributions.
27
28 Takes one optional hash key/pair, 'file', which can be used to
29 specify the path an existing compressed or uncompressed 'find-ls'
30 file. By default a copy will be downloaded and automatically loaded
31 into memory.
32
33 If new returns undef, $Parse::CPAN::Distributions::ERROR will
34 contain the error message recorded.
35
36 Methods
37 listed
38 Given a distribution and version, returns 1 if on CPAN, otherwise
39 0. Note that if version is not provided it will assume you are
40 looking for any version.
41
42 distributions_by
43 Given an author ID, returns a sorted list of the versioned
44 distributions currently available on CPAN.
45
46 author_of
47 Given a distribution and version, returns the author ID if
48 available on CPAN, otherwise undef is returned.
49
50 latest_version
51 Given a distribution, returns the latest known version on CPAN. If
52 given a distribution and author, will return the latest version for
53 that author.
54
55 Note that a return value of 0, implies unknown.
56
57 versions
58 Given a distribution will return all the versions available on
59 CPAN. Given a dsitribution and author, will return all the versions
60 attributed to that author.
61
62 parse
63 Parse find-ls, extracting the list of all the module distributions.
64
66 There are no known bugs at the time of this release. However, if you
67 spot a bug or are experiencing difficulties, that is not explained
68 within the POD documentation, please send bug reports and patches to
69 the RT Queue (see below).
70
71 Fixes are dependent upon their severity and my availability. Should a
72 fix not be forthcoming, please feel free to (politely) remind me.
73
74 RT:
75 http://rt.cpan.org/Public/Dist/Display.html?Name=Parse-CPAN-Distributions
76
78 Parse-CPAN-Authors, Parse-CPAN-Packages
79
81 Barbie, <barbie@cpan.org>
82 for Miss Barbell Productions <http://www.missbarbell.co.uk>.
83
85 Copyright (C) 2008-2014 Barbie for Miss Barbell Productions.
86
87 This distribution is free software; you can redistribute it and/or
88 modify it under the Artistic License v2.
89
90
91
92perl v5.28.0 2014-10-05 Parse::CPAN::Distributions(3)