Earle Martin > OpenGuides-Statistics > OpenGuides::Statistics

Download:
OpenGuides-Statistics-1.2.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
Report a bug
Module Version: 1.2   Source  

NAME ^

OpenGuides::Statistics - generate graphs of the number of nodes on an OpenGuides site

SYNOPSIS ^

    use OpenGuides::Statistics;

    my $stats = 
      OpenGuides::Statistics->new( wiki_conf   => '/path/to/your/openguides/wiki.conf',
                                   import_date => '2000-01-01' );
      
    my ($total_graph, $rate_graph) = $stats->make_graphs;
    my $node_count                 = $stats->node_count;

DESCRIPTION ^

This module will read your OpenGuides database and produce Chart::Strip graphs of the data therein to show you how fast you've accumulated nodes.

METHODS ^

new()

    my $stats =
      OpenGuides::Statistics->new( wiki_conf   => '/path/to/your/openguides/wiki.conf',
                                   import_date => '2000-01-01' );

There's only one required argument, wiki_conf. This is a path to the configuration file of your OpenGuides installation, which this module will load to know how to access your wiki's database. Optional arguments:

make_graphs()

    my ($total_graph, $rate_graph) = $stats->make_graphs;

This method will return two Chart::Strip objects, which have three possible output methods: png() (returns a PNG image), jpeg() (returns a JPEG image) and gd() (returns an underlying GD object). An example of how to use the objects is included in the 'examples' directory of this distribution.

node_count()

    my $node_count = $stats->node_count;

This method will return a scalar value of how many nodes there are in your database.

AUTHOR ^

Earle Martin <EMARTIN@cpan.org>

http://purl.oclc.org/net/earlemartin/

LEGAL ^

Copyright 2005 Earle Martin. All Rights Reserved.

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

SEE ALSO ^

OpenGuides
http://openguides.org/