File Coverage

blib/lib/HTML/FormFu/Plugin/StashValid.pm

Criterion	Covered	Total	%
statement	12	12	100.0
branch	1	2	50.0
condition			n/a
subroutine	3	3	100.0
pod	1	1	100.0
total	17	18	94.4

use strict;

package HTML::FormFu::Plugin::StashValid;
$HTML::FormFu::Plugin::StashValid::VERSION = '2.07';
# ABSTRACT: place valid params on form stash

use Moose;
extends 'HTML::FormFu::Plugin';

sub post_process {
    my ($self) = @_;

    my $form = $self->form;
    my $name = $self->parent->nested_name;

    if ( $form->valid($name) ) {
        $form->stash->{$name} = $form->param($name);
    }

    return;
}

__PACKAGE__->meta->make_immutable;

1;

__END__

=pod

=encoding UTF-8

=head1 NAME

HTML::FormFu::Plugin::StashValid - place valid params on form stash

=head1 VERSION

version 2.07

=head1 SYNOPSIS

    # called on a form or block
    ---
    plugins:
      - type: StashValid
        names: ['field-names']

    # called on a field
    ---
    elements:
      - name: foo
        plugins:
          - StashValid

=head1 DESCRIPTION

Run during the L<HTML::FormFu::Plugin/post_process> hook (called during
L<HTML::FormFu/process>).
If the named field(s) have a valid value after processing, that value is
placed on the form stash, using the field-name as the stash-key.

=head1 METHODS

Arrayref of field names, whose valid values should be stashed.

=head1 SEE ALSO

Is a sub-class of, and inherits methods from L<HTML::FormFu::Plugin>

L<HTML::FormFu>

=head1 AUTHOR

Carl Franks C<[e-mail]>

=head1 LICENSE

This library is free software, you can redistribute it and/or modify it under
the same terms as Perl itself.

=head1 AUTHOR

Carl Franks <[e-mail]>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2018 by Carl Franks.

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