/ 
parrot-0.4.8a
/ Parrot::Configure

NAME

Parrot::Configure - Conducts the execution of Configuration Steps

SYNOPSIS

use Parrot::Configure;

my $conf = Parrot::Configure->new;
my $data = $conf->data;
my $options = $conf->options;
my @steps = $conf->steps;
$conf->add_steps(@steps);
$conf->runsteps;

DESCRIPTION

This module provides provides a means for registering, executing, and coordinating one or more Configuration steps. Please see docs/configuration.pod for further details about the configuration framework.

USAGE

Import Parameters

This module accepts no arguments to its import method and exports no symbols.

Methods

Constructors

  • new()

    Basic constructor.

    Accepts no arguments and returns a Parrot::Configure object.

Object Methods

  • data()

    Provides access to a Parrot::Configure::Data object intended to contain initial and discovered configuration data.

    Accepts no arguments and returns a Parrot::Configure::Data object.

  • options()

    Provides access to a Parrot::Configure::Data object intended to contain CLI option data.

    Accepts no arguments and returns a Parrot::Configure::Data object.

  • steps()

    Provides a list of registered steps. Where each steps is represented by an Parrot::Configure::Task object. Steps are returned in the order in which they were registered in.

    Accepts no arguments and returns a list in list context or an arrayref in scalar context.

  • add_step()

    Registers a new step and any parameters that should be passed to it. With the first parameter being the class name of the step register. All other parameters are saved and passed to the registered class's runstep() method.

    Accepts a list and returns a Parrot::Configure object.

  • add_steps()

    Registers a new step to be run at the end of the execution queue.

    Accepts a list and returns a Parrot::Configure object.

  • runsteps()

    Sequentially executes step in the order they were registered. The invoking Parrot::Configure object is passed as the first argument to each steps runstep() method followed by any parameters that were registered for that step.

    Accepts no arguments and returns a Parrot::Configure object.

  • runstep()

    The invoking Parrot::Configure object is passed as the first argument to each steps runstep() method followed by any parameters that were registered for that step.

    Accepts no arguments and returns a Parrot::Configure object.

CREDITS

The "runsteps()" method is largely based on code written by Brent Royal-Gordon brent@brentdax.com.

AUTHOR

Joshua Hoblitt jhoblitt@cpan.org

SEE ALSO

docs/configuration.pod, Parrot::Configure::Data, Parrot::Configure::Step, Parrot::Configure::Step::Base