JONASBN / Workflow-1.33_5 / lib / Workflow / 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

              
package Workflow::Validator;
# $Id: Validator.pm 454 2009-01-12 10:04:02Z jonasbn $
use warnings;
use strict;
use base qw( Workflow::Base );
use Carp qw(croak);
$Workflow::Validator::VERSION = '1.05';
my @FIELDS = qw( name class );
__PACKAGE__->mk_accessors(@FIELDS);
sub init {
    my ( $self, $params ) = @_;
    if ( $params->{name} ) {
        $self->name( $params->{name} );
    } else {
        $self->name("$params->{class} (init in Action)");
    }
    $self->class( $params->{class} );
    $self->_init($params);
}
sub _init {return}
sub validate {
    my ($self) = @_;
    croak "Class ", ref($self), " must implement 'validate()'!\n";
}
1;
__END__
=head1 NAME
Workflow::Validator - Ensure data are valid
=head1 VERSION
This documentation describes version 1.05 of this package
=head1 SYNOPSIS
 # First declare the validator...
 <validator name="DateValidator"
            class="MyApp::Validator::Date">
   <param name="date_format" value="%Y-%m-%d %h:%m"/>
 </validator>
  
 # Then associate the validator with runtime data from the context...
 <action name="MyAction">
    <validator name="DateValidator">
       <arg>$due_date</arg>
    </validator>
 </action>
  
 # TODO: You can also inintialize and instantiate in one step if you
 # don't need to centralize or reuse (does this work?)
  
 <action name="MyAction">
    <validator class="MyApp::Validator::Date">
       <param name="date_format" value="%Y-%m-%d %h:%m"/>
       <arg>$due_date</arg>
    </validator>
 </action>
  
 # Then implement the logic
  
 package MyApp::Validator::Date;
  
 use strict;
 use base qw( Workflow::Validator );
 use DateTime::Format::Strptime;
 use Workflow::Exception qw( configuration_error );
  
 __PACKAGE__->mk_accessors( 'formatter' );
  
 sub _init {
     my ( $self, $params ) = @_;
     unless ( $params->{date_format} ) {
         configuration_error
             "You must define a value for 'date_format' in ",
             "declaration of validator ", $self->name;
     }
     if ( ref $params->{date_format} ) {
         configuration_error
             "The value for 'date_format' must be a simple scalar in ",
             "declaration of validator ", $self->name;
     }
     my $formatter = DateTime::Format::Strptime->new(
                              pattern => $params->{date_format},
                              on_error => 'undef' );
     $self->formatter( $formatter );
 }
  
 sub validate {
     my ( $self, $wf, $date_string ) = @_;
     my $fmt = $self->formatter;
     my $date_object = $fmt->parse_datetime( $date_string );
     unless ( $date_object ) {
         validation_error
             "Date '$date_string' does not match pattern '", $fmt->pattern, "' ",
             "due to error '", $fmt->errstr, "'";
     }
 }
=head1 DESCRIPTION
Validators specified by 'validator_name' are looked up in the
L<Workflow::Factory> which reads a separate configuration and
generates validators. (Generally all validators should be declared,
but it is not required.)
Validators are objects with a single public method, 'validate()' that
take as arguments a workflow object and a list of parameters. The
parameters are filled in by the workflow engine according to the
instantiation declaration in the Action.
The idea behind a validator is that it validates data but does not
care where it comes from.
=head1 SUBCLASSING
=head2 Strategy
=head2 Methods
=head3 init( \%params )
Called when the validator is first initialized. If you do not have
sufficient information in C<\%params> you should throw an exception.
=head3 _init
This is a I<dummy> method, please see L</init>.
=head3 validate( $workflow, $data )
Determine whether your C<$data> is true or false. If necessary you can
get the application context information from the C<$workflow> object.
=head1 COPYRIGHT
Copyright (c) 2003-2004 Chris Winters. All rights reserved.
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
=head1 AUTHORS
Chris Winters E<lt>chris@cwinters.comE<gt>