The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

WWW::Ohloh::API::Enlistment - an Ohloh enlistment

SYNOPSIS

    use WWW::Ohloh::API;

    my $ohloh = WWW::Ohloh::API->new( api_key => $my_api_key );
    my @enlistments = $ohloh->get_enlistments( 
        project_id => 12933,
    );
    

DESCRIPTION

W::O::A::Enlistment contains the information that join a project with a repository as defined at http://www.ohloh.net/api/reference/enlistment. To be properly populated, it must be created via the get_enlistments method of a WWW::Ohloh::API object.

METHODS

API Data Accessors

id, project_id, repository_id

    my $id            = $enlistment->id;
    my $project_id    = $enlistment->project_id;
    my $repository_id = $enlistment->repository_id;

Return the id of the enlistment / project / repository.

repository

    my $repository = $enlistment->repository

Return the repository associated with the enlistment as a WWW::Ohloh::API::Repository object.

Other Methods

as_xml

Return the account information as an XML string. Note that this is not the exact xml document as returned by the Ohloh server.

SEE ALSO

VERSION

This document describes WWW::Ohloh::API::ContributorLanguageFact version 0.0.6

BUGS AND LIMITATIONS

WWW::Ohloh::API is very extremely alpha quality. It'll improve, but till then: Caveat emptor.

The as_xml() method returns a re-encoding of the account data, which can differ of the original xml document sent by the Ohloh server.

Please report any bugs or feature requests to bug-www-ohloh-api@rt.cpan.org, or through the web interface at http://rt.cpan.org.

AUTHOR

Yanick Champoux <yanick@cpan.org>

LICENCE AND COPYRIGHT

Copyright (c) 2008, Yanick Champoux <yanick@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.