brian d foy > MyCPAN-Indexer-1.28_02 > MyCPAN::Indexer::Reporter::AsYAML

Download:
MyCPAN-Indexer-1.28_02.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

New  1
Open  1
View/Report Bugs
Module Version: 1.28_02   Source   Latest Release: MyCPAN-Indexer-1.28_10

NAME ^

MyCPAN::Indexer::Reporter::AsYAML - Save the result as a YAML file

SYNOPSIS ^

Use this in backpan_indexer.pl by specifying it as the reporter class:

        # in backpan_indexer.config
        reporter_class  MyCPAN::Indexer::Reporter::AsYAML

DESCRIPTION ^

This class takes the result of examining a distribution and saves it.

Methods

get_reporter( $Notes )

get_reporter sets the reporter key in the $Notes hash reference. The value is a code reference that takes the information collected about a distribution and dumps it as a YAML file.

See MyCPAN::Indexer::Tutorial for details about what get_reporter expects and should do.

get_report_file_extension

Returns the extension for reports from this reporter. Since we're making YAML files, that's yml.

final_words( $Notes )

Right before backpan_indexer.pl is about to finish, it calls this method to give the reporter a chance to do something at the end. In this case it does nothing.

TO DO ^

SOURCE AVAILABILITY ^

This code is in Github:

        git://github.com/briandfoy/mycpan-indexer.git

AUTHOR ^

brian d foy, <bdfoy@cpan.org>

COPYRIGHT AND LICENSE ^

Copyright (c) 2008-2009, brian d foy, All Rights Reserved.

You may redistribute this under the same terms as Perl itself.

syntax highlighting: