MyCPAN::Indexer::Component - base class for MyCPAN components


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

Index


NAME

Top

MyCPAN::Indexer::Component - base class for MyCPAN components

SYNOPSIS

Top

	package MyCPAN::Indexer::NewComponent;

	use base qw(MyCPAN::Indexer::Component);




DESCRIPTION

Top

This module implements features common to all MyCPAN::Indexer components. Each component is able to communicate with a coordinator object to find out the results and notes left by other components. Most of that delegation infrastructure is hidden since each component can call methods on its own instances that this module dispatches appropriately.

Methods

new( [COORDINATOR] )

Create a new component object. This is mostly to have a place to store a reference to the coordinator object. See get_coordinator.

get_coordinator

Get the coordinator object. This is the object that coordinates all of the components. Each component communicates with the coordinator and other components can see it.

set_coordinator( $coordinator )

Set the coordinator object. new already does this for you if you pass it a coordinator object. Each component expects the cooridnator object to respond to these methods:

	get_info
	set_info
	get_note
	set_note
	get_config
	set_config
	increment_note
	decrement_note
	push_onto_note
	unshift_onto_note
	get_note_list_element
	set_note_unless_defined




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.