File Coverage

blib/lib/Form/Factory/Feature/Role/PreProcess.pm

Criterion	Covered	Total	%
statement	3	3	100.0
branch			n/a
condition			n/a
subroutine	1	1	100.0
pod			n/a
total	4	4	100.0

package Form::Factory::Feature::Role::PreProcess;
$Form::Factory::Feature::Role::PreProcess::VERSION = '0.022';
use Moose::Role;

requires qw( pre_process );

# ABSTRACT: features that run just before processing


1;

__END__

=pod

=encoding UTF-8

=head1 NAME

Form::Factory::Feature::Role::PreProcess - features that run just before processing

=head1 VERSION

version 0.022

=head1 SYNOPSIS

  package MyApp::Feature::Baz;
  use Moose;

  with qw(
      Form::Factory::Feature
      Form::Factory::Feature::Role::PreProcess
  );

  sub pre_process {
      my $self = shift;
      MyApp::Logger->info('Starting to process.');
  }

  package Form::Factory::Feature::Custom::Baz;
  sub register_implementation { 'MyApp::Feature::Baz' }

=head1 DESCRIPTION

Features that run something immediately before the action runs may implement this role. This feature cannot stop the action from running. That must be performed with a L<Form::Factory::Feature::Role::Check>.

=head1 ROLE METHOD

=head2 pre_process

This method is called immediately before the C<run> method is called. It is passed no arguments other than the feature object it is called upon. It's return value is ignored.

This method can be used to prevent the C<run> method from being called by throwing an exception.

=head1 AUTHOR

Andrew Sterling Hanenkamp <[e-mail]>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2015 by Qubling Software LLC.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

=cut