CPAN-Visitor

 view release on metacpan or  search on metacpan

README  view on Meta::CPAN

        things

    *   "stash" — the 'stash' hashref from the Visitor object

    *   "quiet" — the 'quiet' flag from the Visitor object

    *   "result" — an empty hashref to start; the return values from each
        action are added and may be referenced by subsequent actions

    The "result" field is used to accumulate the return values from action
    callbacks. For example, the return value from the default 'extract'
    action is the unpacked distribution directory:

      $job->{result}{extract} # distribution directory path

    You do not need to store the results yourself — the "iterate" method
    takes care of it for you.

    Callbacks occur in the following order. Some callbacks skip further
    processing if the return value is false.

    *   "check" — determines whether the distribution should be processed;
        goes to next file if false; default is always true

    *   "start" — used for any setup, logging, etc; default does nothing

    *   "extract" — operate on the tarball to prepare for visiting; skips to
        finish action if it returns a false value; the default extracts a
        distribution into a temp directory and returns the path to the

lib/CPAN/Visitor.pm  view on Meta::CPAN

# iteration methods
#--------------------------------------------------------------------------#

# iterate()
#
# Arguments:
#
#   jobs -- if greater than 1, distributions are processed in parallel
#           via Parallel::ForkManager
#
# iterate() takes several optional callbacks which are run in the following
# order.  Callbacks get a single hashref argument as described above under
# default actions.
#
#   check -- whether the distribution should be processed; goes to next file
#            if false; default is always true
#
#   start -- used for any setup, logging, etc; default does nothing
#
#   extract -- extracts a distribution into a temp directory or otherwise
#              prepares for visiting; skips to finish action if it returns

lib/CPAN/Visitor.pm  view on Meta::CPAN


C<quiet>    — the 'quiet' flag from the Visitor object

=item *

C<result>   — an empty hashref to start; the return values from each action are added and may be referenced by subsequent actions

=back

The C<result> field is used to accumulate the return values from action
callbacks.  For example, the return value from the default 'extract' action is
the unpacked distribution directory:

  $job->{result}{extract} # distribution directory path

You do not need to store the results yourself — the C<iterate> method
takes care of it for you.

Callbacks occur in the following order.  Some callbacks skip further
processing if the return value is false.

=over 4

=item *

C<check> — determines whether the distribution should be processed; goes to next file if false; default is always true

=item *



( run in 1.119 second using v1.01-cache-2.11-cpan-9b1e4054eb1 )