/ 
WWW-Ohloh-API-1.0_0
River stage zero No dependents
/ WWW::Ohloh::API::StackEntry

NAME

WWW::Ohloh::API::StackEntry - A project entry in a stack

SYNOPSIS

use WWW::Ohloh::API;

my $ohloh = WWW::Ohloh::API->new( api_key => $my_api_key );

# from an account
my @entries = $ohloh->fetch_account_stack( $account_id )->stack_entries;

# from a project
my @stacks = $ohloh->get_project_stacks( $project_id );
my @entries = $stacks[0]->stack_entries;

DESCRIPTION

W::O::A::StackEntry represents one project in a stack.

METHODS

API Data Accessors

$entry->id

Returns the unique id for the stack entry.

$entry->created_at

Returns the time at which the project was added to the stack.

$entry->stack_id

Returns the id of the stack containing the entry.

$entry->project_id

Returns the id of the project.

$entry->project( $retrieve )

Returns the project as a WWW::Ohloh::API::Project object.

If the optional argument $retrieve is given and false, the project will not be queried from the Ohloh server if it's not already known, and the method will return nothing.

Other Methods

as_xml

Return the stack entry as an XML string. Note that this is not the same xml document as returned by the Ohloh server.

SEE ALSO

  • WWW::Ohloh::API.

  • Ohloh API reference: http://www.ohloh.net/api/getting_started

  • Ohloh Account API reference: http://www.ohloh.net/api/reference/stack_entry

VERSION

This document describes WWW::Ohloh::API version 1.0_0

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

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.