The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

CFRANKS / HTML-FormFu-2.07 / lib / HTML / FormFu / Validator.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
—
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160

              
use strict;
package HTML::FormFu::Validator;
$HTML::FormFu::Validator::VERSION = '2.07';
# ABSTRACT: Validator Base Class
use Moose;
extends 'HTML::FormFu::Processor';
use HTML::FormFu::Exception::Validator;
use Scalar::Util qw( reftype blessed );
use Carp qw( croak );
sub process {
    my ( $self, $params ) = @_;
    my $value = $self->get_nested_hash_value( $params, $self->nested_name );
    my @errors;
    if ( ( reftype($value) || '' ) eq 'ARRAY' ) {
        push @errors, eval { $self->validate_values( $value, $params ) };
        if ($@) {
            push @errors, $self->return_error($@);
        }
    }
    else {
        my $ok = eval { $self->validate_value( $value, $params ) };
        if ( $@ or !$ok ) {
            push @errors, $self->return_error($@);
        }
    }
    return @errors;
}
sub validate_values {
    my ( $self, $values, $params ) = @_;
    my @errors;
    for my $value (@$values) {
        my $ok = eval { $self->validate_value( $value, $params ) };
        push @errors, $self->return_error($@) if !$ok;
    }
    return @errors;
}
sub validate_value {
    croak "validate() should be overridden";
}
sub return_error {
    my ( $self, $err ) = @_;
    if ( !blessed $err || !$err->isa('HTML::FormFu::Exception::Validator') ) {
        $err = HTML::FormFu::Exception::Validator->new(
            $err ? { message => $err } : () );
    }
    return $err;
}
__PACKAGE__->meta->make_immutable;
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
HTML::FormFu::Validator - Validator Base Class
=head1 VERSION
version 2.07
=head1 SYNOPSIS
=head1 DESCRIPTION
=head1 METHODS
=head1 CORE VALIDATORS
=over
=item L<HTML::FormFu::Validator::Callback>
=back
=head1 BEST PRACTICES
Try to avoid using callbacks if possible. Below is a more maintainable
and reusable approach, which also keeps the code out of the controller.
A normal application's directory would contain:
    lib/HTML/FormFu/Constraint/MyApp/
    lib/HTML/FormFu/Validator/MyApp/
    lib/HTML/FormFu/Plugin/MyApp/
    etc.
Then, the form config file would just need:
    validator: 'MyApp::SomeValidator'
And the class would be something like this:
    package HTML::FormFu::Validator::MyApp::SomeValidator;
    use Moose;
    extends 'HTML::FormFu::Validator';
    sub validate_value {
        my ( $self, $value, $params ) = @_;
        my $c = $self->form->stash->{context};
        return 1 if $c->model('DBIC')->is_valid($value);
        # assuming you want to return a custom error message
        # which perhaps includes something retrieved from the model
        # otherwise, just return 0
        die HTML::FormFu::Exception::Validator->new({
            message => 'custom error message',
        });
    }
    1;
=head1 AUTHOR
Carl Franks, C<cfranks@cpan.org>
=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 <cpan@fireartist.com>
=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