/ 
WWW-Ohloh-API-v0.3.2
River stage zero No dependents
/ WWW::Ohloh::API::Enlistments

NAME

WWW::Ohloh::API::Enlistments - a set of Ohloh project enlistments

SYNOPSIS

use WWW::Ohloh::API;
use WWW::Ohloh::API::Enlistments;

my $ohloh = WWW::Ohloh::API( api_key => $key );

my $enlistments = $ohloh->get_enlistments( project_id => 123 );

while ( my $e = $enlistments->next ) {
    print $e->repository->url;
}

DESCRIPTION

W::O::A::Enlistments returns a list of enlistments for a project.

The object doesn't retrieve all enlistmentss from the Ohloh server in one go, but rather fetch them in small groups as required. If you want to download all enlistments at the same time, you can use the all() method:

my @e = $ohloh->get_enlistments( sort => 'module_name' )->all;

METHODS

new( %args )

Creates a new W::O::A::Enlistments object. It accepts the following arguments:

Arguments

ohloh => $ohloh

Mandatory. Its value is the WWW::Ohloh::API object that will be used to query the Ohloh server.

max => $n

The maximum number of enlistments the set will contain. If you want to slurp'em all, set it to 'undef' (which is the default).

all

Returns the retrieved enlistments' information as WWW::Ohloh::API::Enlistment objects.

next( $n )

Returns the next $n enlistment (or all remaining enlistments if there are less than $n), or undef if there is no more enlistments to retrieve. After it returned undef, subsequent calls to next will reset the list. If $n is not given, defaults to 1 entry.

max

Returns the maximum number of enlistments the object will return, or undef if no maximum has been set.

total_entries

Returns the number of entries selected by the query.

Beware: this number can change during the life of the object! Each time the object retrieves a new batch of entries, this number is updated with the value returned by the Ohloh server, which could differ from its last invication is entries have been added or removed since the last retrieval.

SEE ALSO

VERSION

This document describes WWW::Ohloh::API version 0.3.2

BUGS AND LIMITATIONS

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

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

Yuval Kogman and 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.