Yanick Champoux > WWW-Ohloh-API > WWW::Ohloh::API::Factoid

Download:
WWW-Ohloh-API-v0.3.2.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  1
View/Report Bugs
Module Version: v0.3.2   Source  

NAME ^

WWW::Ohloh::API::Factoid - A factoid about an Ohloh project

SYNOPSIS ^

    use WWW::Ohloh::API;

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

    print join "\n", map { $_->type } @factoids;

DESCRIPTION ^

W::O::A::Factoid is a bit of information about a project.

METHODS ^

API Data Accessors

id

    $id = $factoid->id;

Return the id of the factoid. Note that the ids change every time that a project is reanalyzed.

analysis_id

    $id = $factoid->analysis_id;

Return the id of the analysis used to create the factoid.

type

    $type = $factoid->type;

Return the factoid type.

description

    $desc = $factoid->description;

Return a description of the factoid type.

severity

    $sev = $factoid->severity;

Return the factoid's severity (ranges between -3 and +3).

license_id

    $license_id = $factoid->license_id;

If the factoid's type is FactoidGplConflict, return the id of the conflicting license.

Other Methods

as_xml

Return the activity fact 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 version 0.3.2

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 activity fact 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.

syntax highlighting: