File Coverage

blib/lib/HTML/FormFu/Filter/Callback.pm

Criterion	Covered	Total	%
statement	16	16	100.0
branch			n/a
condition	2	2	100.0
subroutine	6	6	100.0
pod	0	1	0.0
total	24	25	96.0

package HTML::FormFu::Filter::Callback;

use strict;
our $VERSION = '2.05'; # VERSION

use Moose;
use MooseX::Attribute::FormFuChained;
extends 'HTML::FormFu::Filter';

has callback => ( is => 'rw', traits => ['FormFuChained'] );

sub filter {
    my ( $self, $value, $params ) = @_;

    my $callback = $self->callback || sub {$value};

    ## no critic (ProhibitNoStrict);
    no strict 'refs';

    return $callback->( $value, $params );
}

__PACKAGE__->meta->make_immutable;

1;

__END__

=head1 NAME

HTML::FormFu::Filter::Callback - filter with custom subroutine

=head1 VERSION

version 2.05

=head1 SYNOPSIS

    $field->filter({
        type     => 'Callback',
        callback => \&my_filter,
    });

    ---
    elements:
      - type: Text
        name: foo
        filters:
          - type: Callback
            callback: "main::my_filter"

    sub my_filter {
        my ($value) = @_;

        # do something to $value

        return $value;
    }

=head1 DESCRIPTION

Filter using a user-provided subroutine.

=head1 METHODS

=head2 callback

Arguments: \&code-reference

Arguments: "subroutine-name"

=head1 AUTHOR

Carl Franks, C<[e-mail]>

Based on the original source code of L<HTML::Widget::Filter::Callback>, by
Lyo Kato, 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.

=cut