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


MyCPAN-Indexer documentation  | view source Contained in the MyCPAN-Indexer distribution.

Index


NAME

Top

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

SYNOPSIS

Top

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

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

DESCRIPTION

Top

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

Top

SOURCE AVAILABILITY

Top

This code is in Github:

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

AUTHOR

Top

brian d foy, <bdfoy@cpan.org>

COPYRIGHT AND LICENSE

Top


MyCPAN-Indexer documentation  | view source Contained in the MyCPAN-Indexer distribution.