NAME

CPAN::Index::API::File::Whois - Interface to 00whois.xml

VERSION

version 0.007

SYNOPSIS

  my $mailrc = CPAN::Index::File::Whois->parse_from_repo_uri(
    'http://cpan.perl.org'
  );

  foreach my $author ($mailrc->authors) {
    ... # do something
  }

DESCRIPTION

This is a class to read and write 01mailrc.txt

METHODS

authors

List of hashres containing author data. The structure of the hashrefs is as follows:

cpanid: CPAN id of the author, required.
full_name: Author's full name. Can be an empty string.
ascii_name: Author's full name, but conatining only ASCII characters.
email: Author's email.
has_cpandir: Boolean - true if the author has a cpan directory.
homepate: Author's homepage.
ino: Additional information about the author.
type: Author type, usually author.

authors_count

Number of authors in this file.

author

Method that fetches the entry for a given cpanid.

parse

Parses the file and reurns its representation as a data structure.

default_location

Default file location - authors/00whois.xml.

METHODS FROM ROLES

<CPAN::Index::API::Role::Readable/read_from_string>
<CPAN::Index::API::Role::Readable/read_from_file>
<CPAN::Index::API::Role::Readable/read_from_tarball>
<CPAN::Index::API::Role::Readable/read_from_repo_path>
<CPAN::Index::API::Role::Readable/read_from_repo_uri>
"tarball_is_default" in CPAN::Index::API::Role::Writable
"repo_path" in CPAN::Index::API::Role::Writable
"template" in CPAN::Index::API::Role::Writable
"content" in CPAN::Index::API::Role::Writable
"write_to_file" in CPAN::Index::API::Role::Writable
"write_to_tarball" in CPAN::Index::API::Role::Writable
"clone" in CPAN::Index::API::Role::Clonable
"generated_by" in CPAN::Index::API::Role::HavingGeneratedBy
"last_generated" in CPAN::Index::API::Role::HavingGeneratedBy

AUTHOR

Peter Shangov <pshangov@yahoo.com>

COPYRIGHT AND LICENSE

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.