File: README

package info (click to toggle)
libdata-formvalidator-perl 4.70-1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 676 kB
  • sloc: perl: 2,839; makefile: 2
file content (883 lines) | stat: -rw-r--r-- 33,303 bytes parent folder | download | duplicates (2)
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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
NAME
    Data::FormValidator - Validates user input (usually from an HTML form)
    based on input profile.

SYNOPSIS
     use Data::FormValidator;

     my $results = Data::FormValidator->check(\%input_hash, \%dfv_profile);

     if ($results->has_invalid or $results->has_missing) {
         # do something with $results->invalid, $results->missing
         # or  $results->msgs
     }
     else {
         # do something with $results->valid
     }

DESCRIPTION
    Data::FormValidator's main aim is to make input validation expressible
    in a simple format.

    Data::FormValidator lets you define profiles which declare the required
    and optional fields and any constraints they might have.

    The results are provided as an object which makes it easy to handle
    missing and invalid results, return error messages about which
    constraints failed, or process the resulting valid data.

VALIDATING INPUT
  check()
     my $results = Data::FormValidator->check(\%input_hash, \%dfv_profile);

    "check" is the recommended method to use to validate forms. It returns
    its results as a Data::FormValidator::Results object. A deprecated
    method "validate" is also available, returning its results as an array
    described below.

     use Data::FormValidator;
     my $results = Data::FormValidator->check(\%input_hash, \%dfv_profile);

    Here, "check()" is used as a class method, and takes two required
    parameters.

    The first a reference to the data to be be validated. This can either be
    a hash reference, or a CGI.pm-like object. In particular, the object
    must have a param() method that works like the one in CGI.pm does.
    CGI::Simple and Apache::Request objects are known to work in particular.
    Note that if you use a hash reference, multiple values for a single key
    should be presented as an array reference.

    The second argument is a reference to the profile you are validating.

  validate()
        my( $valids, $missings, $invalids, $unknowns ) =
            Data::FormValidator->validate( \%input_hash, \%dfv_profile);

    "validate()" provides a deprecated alternative to "check()". It has the
    same input syntax, but returns a four element array, described as
    follows

    valids
        This is a hash reference to the valid fields which were submitted in
        the data. The data may have been modified by the various filters
        specified.

    missings
        This is a reference to an array which contains the name of the
        missing fields. Those are the fields that the user forget to fill or
        filled with spaces. These fields may comes from the *required* list
        or the *dependencies* list.

    invalids
        This is a reference to an array which contains the name of the
        fields which failed one or more of their constraint checks. If there
        are no invalid fields, an empty arrayref will be returned.

        Fields defined with multiple constraints will have an array ref
        returned in the @invalids array instead of a string. The first
        element in this array is the name of the field, and the remaining
        fields are the names of the failed constraints.

    unknowns
        This is a list of fields which are unknown to the profile. Whether
        or not this indicates an error in the user input is application
        dependent.

  new()
    Using "new()" is only needed for advanced usage, including these cases:

    o   Loading more than one profile at a time. Then you can select the
        profile you want by name later with "check()". Here's an example:

         my $dfv = Data::FormValidator->new({
            profile_1 => { # usual profile definition here },
            profile_2 => { # another profile definition },
         });

        As illustrated, multiple profiles are defined through a hash ref
        whose keys point to profile definitions.

        You can also load several profiles from a file, by defining several
        profiles as shown above in an external file. Then just pass in the
        name of the file:

         my $dfv = Data::FormValidator->new('/path/to/profiles.pl');

        If the input profile is specified as a file name, the profiles will
        be reread each time that the disk copy is modified.

        Now when calling "check()", you just need to supply the profile
        name:

         my $results = $dfv->check(\%input_hash,'profile_1');

    o   Applying defaults to more than one input profile. There are some
        parts of the validation profile that you might like to re-use for
        many form validations.

        To facilitate this, "new()" takes a second argument, a hash
        reference. Here the usual input profile definitions can be made.
        These will act as defaults for any subsequent calls to "check()" on
        this object.

        Currently the logic for this is very simple. Any definition of a key
        in your validation profile will completely overwrite your default
        value.

        This means you can't define two keys for "constraint_regexp_map" and
        expect they will always be there. This kind of feature may be added
        in the future.

        The exception here is definitions for your "msgs" key. You will
        safely be able to define some defaults for the top level keys within
        "msgs" and not have them clobbered just because "msgs" was defined
        in a validation profile.

        One way to use this feature is to create your own sub-class that
        always provides your defaults to "new()".

        Another option is to create your own wrapper routine which provides
        these defaults to "new()". Here's an example of a routine you might
        put in a CGI::Application super-class to make use of this feature:

         # Always use the built-in CGI object as the form data
         # and provide some defaults to new constructor
         sub check_form {
             my $self = shift;
             my $profile = shift
                || die 'check_form: missing required profile';

             require Data::FormValidator;
             my $dfv = Data::FormValidator->new({},{
                # your defaults here
             });
             return $dfv->check($self->query,$profile);
         }

INPUT PROFILE SPECIFICATION
    An input profile is a hash reference containing one or more of the
    following keys.

    Here is a very simple input profile. Examples of more advanced options
    are described below.

        use Data::FormValidator::Constraints qw(:closures);

        my $profile = {
            optional => [qw( company
                             fax
                             country )],

            required => [qw( fullname
                             phone
                             email
                             address )],

            constraint_methods => {
                email => email(),
            }
        };

    That defines some fields as optional, some as required, and defines that
    the field named 'email' must pass the constraint named 'email'.

    Here is a complete list of the keys available in the input profile, with
    examples of each.

  required
    This is an array reference which contains the name of the fields which
    are required. Any fields in this list which are not present or contain
    only spaces will be reported as missing.

  required_regexp
     required_regexp => qr/city|state|zipcode/,

    This is a regular expression used to specify additional field names for
    which values will be required.

  require_some
     require_some => {
        # require any two fields from this group
        city_or_state_or_zipcode => [ 2, qw/city state zipcode/ ],
     }

    This is a reference to a hash which defines groups of fields where 1 or
    more fields from the group should be required, but exactly which fields
    doesn't matter. The keys in the hash are the group names. These are
    returned as "missing" unless the required number of fields from the
    group has been filled in. The values in this hash are array references.
    The first element in this array should be the number of fields in the
    group that is required. If the first field in the array is not an a
    digit, a default of "1" will be used.

  optional
     optional => [qw/meat coffee chocolate/],

    This is an array reference which contains the name of optional fields.
    These are fields which MAY be present and if they are, they will be
    checked for valid input. Any fields not in optional or required list
    will be reported as unknown.

  optional_regexp
     optional_regexp => qr/_province$/,

    This is a regular expression used to specify additional fields which are
    optional. For example, if you wanted all fields names that begin with
    *user_* to be optional, you could use the regular expression, /^user_/

  dependencies
     dependencies   => {

        # If cc_no is entered, make cc_type and cc_exp required
        "cc_no" => [ qw( cc_type cc_exp ) ],

        # if pay_type eq 'check', require check_no
        "pay_type" => {
            check => [ qw( check_no ) ],
         }

        # if cc_type is VISA or MASTERCARD require CVV
        "cc_type" => sub {
            my $dfv  = shift;
            my $type = shift;

            return [ 'cc_cvv' ] if ($type eq "VISA" || $type eq "MASTERCARD");
            return [ ];
        },
     },

    This is for the case where an optional field has other requirements. The
    dependent fields can be specified with an array reference.

    If the dependencies are specified with a hash reference then the
    additional constraint is added that the optional field must equal a key
    for the dependencies to be added.

    If the dependencies are specified as a code reference then the code will
    be executed to determine the dependent fields. It is passed two
    parameters, the object and the value of the field, and it should return
    an array reference containing the list of dependent fields.

    Any fields in the dependencies list that are missing when the target is
    present will be reported as missing.

  dependency_groups
     dependency_groups  => {
         # if either field is filled in, they all become required
         password_group => [qw/password password_confirmation/],
     }

    This is a hash reference which contains information about groups of
    interdependent fields. The keys are arbitrary names that you create and
    the values are references to arrays of the field names in each group.

  defaults
     defaults => {
         country => "USA",
     },

    This is a hash reference where keys are field names and values are
    defaults to use if input for the field is missing.

    The values can be code refs which will be used to calculate the value if
    needed. These code refs will be passed in the DFV::Results object as the
    only parameter.

    The defaults are set shortly before the constraints are applied, and
    will be returned with the other valid data.

  defaults_regexp_map
      defaults_regexp_map => {
          qr/^opt_/ => 1,
      },

    This is a hash reference that maps regular expressions to default values
    to use for matching optional or required fields.

    It's useful if you have generated many checkbox fields with the similar
    names. Since checkbox fields submit nothing at all when they are not
    checked, it's useful to set defaults for them.

    Note that it doesn't make sense to use a default for a field handled by
    "optional_regexp" or "required_regexp". When the field is not submitted,
    there is no way to know that it should be optional or required, and thus
    there's no way to know that a default should be set for it.

  filters
     # trim leading and trailing whitespace on all fields
     filters       => ['trim'],

    This is a reference to an array of filters that will be applied to ALL
    optional and required fields, before any constraints are applied.

    This can be the name of a built-in filter (trim,digit,etc) or an
    anonymous subroutine which should take one parameter, the field value
    and return the (possibly) modified value.

    Filters modify the data returned through the results object, so use them
    carefully.

    See Data::FormValidator::Filters for details on the built-in filters.

  field_filters
     field_filters => {
         cc_no => ['digit'],
     },

    A hash ref with field names as keys. Values are array references of
    built-in filters to apply (trim,digit,etc) or an anonymous subroutine
    which should take one parameter, the field value and return the
    (possibly) modified value.

    Filters are applied before any constraints are applied.

    See Data::FormValidator::Filters for details on the built-in filters.

  field_filter_regexp_map
     field_filter_regexp_map => {
         # Upper-case the first letter of all fields that end in "_name"
         qr/_name$/    => ['ucfirst'],
     },

    'field_filter_regexp_map' is used to apply filters to fields that match
    a regular expression. This is a hash reference where the keys are the
    regular expressions to use and the values are references to arrays of
    filters which will be applied to specific input fields. Just as with
    'field_filters', you can you use a built-in filter or use a coderef to
    supply your own.

  constraint_methods
     use Data::FormValidator::Constraints qw(:closures);

     constraint_methods => {
        cc_no      => cc_number({fields => ['cc_type']}),
        cc_type    => cc_type(),
        cc_exp     => cc_exp(),
      },

    A hash ref which contains the constraints that will be used to check
    whether or not the field contains valid data.

    Note: To use the built-in constraints, they need to first be loaded into
    your name space using the syntax above. (Unless you are using the old
    "constraints" key, documented in "BACKWARDS COMPATIBILITY").

    The keys in this hash are field names. The values can be any of the
    following:

    o   A named constraint.

        Example:

         my_zipcode_field     => zip(),

        See Data::FormValidator::Constraints for the details of which
        built-in constraints that are available.

    o   A perl regular expression

        Example:

         my_zipcode_field   => qr/^\d{5}$/, # match exactly 5 digits

        If this field is named in "untaint_constraint_fields" or
        "untaint_regexp_map", or "untaint_all_constraints" is effective, be
        aware of the following: If you write your own regular expressions
        and only match part of the string then you'll only get part of the
        string in the valid hash. It is a good idea to write you own
        constraints like /^regex$/. That way you match the whole string.

    o   a subroutine reference, to supply custom code

        This will check the input and return true or false depending on the
        input's validity. By default, the constraint function receives a
        Data::FormValidator::Results object as its first argument, and the
        value to be validated as the second. To validate a field based on
        more inputs than just the field itself, see "VALIDATING INPUT BASED
        ON MULTIPLE FIELDS".

        Examples:

         # Notice the use of 'pop'--
         # the object is the first arg passed to the method
         # while the value is the second, and last arg.
         my_zipcode_field => sub { my $val = pop;  return $val =~ '/^\d{5}$/' },

         # OR you can reference a subroutine, which should work like the one above
         my_zipcode_field => \&my_validation_routine,

         # An example of setting the constraint name.
         my_zipcode_field => sub {
            my ($dfv, $val) = @_;
            $dfv->set_current_constraint_name('my_constraint_name');
            return $val =~ '/^\d{5}$/'
         },

    o   an array reference

        An array reference is used to apply multiple constraints to a single
        field. Any of the above options are valid entries the array. See
        "MULTIPLE CONSTRAINTS" below.

        For more details see "VALIDATING INPUT BASED ON MULTIPLE FIELDS".

  constraint_method_regexp_map
     use Data::FormValidator::Constraints qw(:closures);

     # In your profile.
     constraint_method_regexp_map => {
         # All fields that end in _postcode have the 'postcode' constraint applied.
         qr/_postcode$/    => postcode(),
     },

    A hash ref where the keys are the regular expressions to use and the
    values are the constraints to apply.

    If one or more constraints have already been defined for a given field
    using "constraint_methods", "constraint_method_regexp_map" will add an
    additional constraint for that field for each regular expression that
    matches.

  untaint_all_constraints
     untaint_all_constraints => 1,

    If this field is set, all form data that passes a constraint will be
    untainted. The untainted data will be returned in the valid hash.
    Untainting is based on the pattern match used by the constraint. Note
    that some constraint routines may not provide untainting.

    See Writing your own constraint routines for more information.

    This is overridden by "untaint_constraint_fields" and
    "untaint_regexp_map".

  untaint_constraint_fields
     untaint_constraint_fields => [qw(zipcode state)],

    Specifies that one or more fields will be untainted if they pass their
    constraint(s). This can be set to a single field name or an array
    reference of field names. The untainted data will be returned in the
    valid hash.

    This overrides the untaint_all_constraints flag.

  untaint_regexp_map
     untaint_regexp_map => [qr/some_field_\d/],

    Specifies that certain fields will be untainted if they pass their
    constraints and match one of the regular expressions supplied. This can
    be set to a single regex, or an array reference of regexes. The
    untainted data will be returned in the valid hash.

    The above example would untaint the fields named "some_field_1", and
    "some_field_2" but not "some_field".

    This overrides the untaint_all_constraints flag.

  missing_optional_valid
     missing_optional_valid => 1

    This can be set to a true value to cause optional fields with empty
    values to be included in the valid hash. By default they are not
    included-- this is the historical behavior.

    This is an important flag if you are using the contents of an "update"
    form to update a record in a database. Without using the option, fields
    that have been set back to "blank" may fail to get updated.

  validator_packages
     # load all the constraints and filters from these modules
     validator_packages => [qw(Data::FormValidator::Constraints::Upload)],

    This key is used to define other packages which contain constraint
    routines or filters. Set this key to a single package name, or an
    arrayref of several. All of its constraint and filter routines beginning
    with 'match_', 'valid_' and 'filter_' will be imported into
    Data::FormValidator. This lets you reference them in a constraint with
    just their name, just like built-in routines. You can even override the
    provided validators.

    See Writing your own constraint routines documentation for more
    information

  msgs
    This key is used to define parameters related to formatting error
    messages returned to the user.

    By default, invalid fields have the message "Invalid" associated with
    them while missing fields have the message "Missing" associated with
    them.

    In the simplest case, nothing needs to be defined here, and the default
    values will be used.

    The default formatting applied is designed for display in an XHTML web
    page. That formatting is as followings:

        <span style="color:red;font-weight:bold" class="dfv_errors">* %s</span>

    The %s will be replaced with the message. The effect is that the message
    will appear in bold red with an asterisk before it. This style can be
    overridden by simply defining "dfv_errors" appropriately in a style
    sheet, or by providing a new format string.

    Here's a more complex example that shows how to provide your own default
    message strings, as well as providing custom messages per field, and
    handling multiple constraints:

     msgs => {

         # set a custom error prefix, defaults to none
         prefix=> 'error_',

         # Set your own "Missing" message, defaults to "Missing"
         missing => 'Not Here!',

         # Default invalid message, default's to "Invalid"
         invalid => 'Problematic!',

         # message separator for multiple messages
         # Defaults to ' '
         invalid_separator => ' <br /> ',

         # formatting string, default given above.
         format => 'ERROR: %s',

         # Error messages, keyed by constraint name
         # Your constraints must be named to use this.
         constraints => {
                         'date_and_time' => 'Not a valid time format',
                         # ...
         },

         # This token will be included in the hash if there are
         # any errors returned. This can be useful with templating
         # systems like HTML::Template
         # The 'prefix' setting does not apply here.
         # defaults to undefined
         any_errors => 'some_errors',
     }

    The hash that's prepared can be retrieved through the "msgs" method
    described in the Data::FormValidator::Results documentation.

  msgs - callback
    *This is a new feature. While it expected to be forward-compatible, it
    hasn't yet received the testing the rest of the API has.*

    If the built-in message generation doesn't suit you, it is also possible
    to provide your own by specifying a code reference:

     msgs  =>  \&my_msgs_callback

    This will be called as a Data::FormValidator::Results method. It may
    receive as arguments an additional hash reference of control parameters,
    corresponding to the key names usually used in the "msgs" area of the
    profile. You can ignore this information if you'd like.

    If you have an alternative error message handler you'd like to share,
    stick in the "Data::FormValidator::ErrMsgs" name space and upload it to
    CPAN.

  debug
    This method is used to print details about what is going on to STDERR.

    Currently only level '1' is used. It provides information about which
    fields matched constraint_regexp_map.

  A shortcut for array refs
    A number of parts of the input profile specification include array
    references as their values. In any of these places, you can simply use a
    string if you only need to specify one value. For example, instead of

     filters => [ 'trim' ]

    you can simply say

     filters => 'trim'

  A note on regular expression formats
    In addition to using the preferred method of defining regular
    expressions using "qr", a deprecated style of defining them as strings
    is also supported.

    Preferred:

     qr/this is great/

    Deprecated, but supported

     'm/this still works/'

VALIDATING INPUT BASED ON MULTIPLE FIELDS
    You can pass more than one value into a constraint routine. For that,
    the value of the constraint should be a hash reference. If you are
    creating your own routines, be sure to read the section labeled "WRITING
    YOUR OWN CONSTRAINT ROUTINES", in the Data::FormValidator::Constraints
    documentation. It describes a newer and more flexible syntax.

    Using the original syntax, one key should be named "constraint" and
    should have a value set to the reference of the subroutine or the name
    of a built-in validator. Another required key is "params". The value of
    the "params" key is a reference to an array of the other elements to use
    in the validation. If the element is a scalar, it is assumed to be a
    field name. The field is known to Data::FormValidator, the value will be
    filtered through any defined filters before it is passed in. If the
    value is a reference, the reference is passed directly to the routine.
    Don't forget to include the name of the field to check in that list, if
    you are using this syntax.

    Example:

     cc_no  => {
         constraint  => "cc_number",
         params         => [ qw( cc_no cc_type ) ],
     },

MULTIPLE CONSTRAINTS
    Multiple constraints can be applied to a single field by defining the
    value of the constraint to be an array reference. Each of the values in
    this array can be any of the constraint types defined above.

    When using multiple constraints it is important to return the name of
    the constraint that failed so you can distinguish between them. To do
    that, either use a named constraint, or use the hash ref method of
    defining a constraint and include a "name" key with a value set to the
    name of your constraint. Here's an example:

     my_zipcode_field => [
         'zip',
         {
           constraint =>  '/^406/',
           name        =>  'starts_with_406',
         }
     ],

    You can use an array reference with a single constraint in it if you
    just want to have the name of your failed constraint returned in the
    above fashion.

    Read about the "validate()" function above to see how multiple
    constraints are returned differently with that method.

ADVANCED VALIDATION
    For even more advanced validation, you will likely want to read the
    documentation for other modules in this distribution, linked below. Also
    keep in mind that the Data::FormValidator profile structure is just
    another data structure. There is no reason why it needs to be defined
    statically. The profile could also be built on the fly with custom Perl
    code.

BACKWARDS COMPATIBILITY
  validate()
        my( $valids, $missings, $invalids, $unknowns ) =
            Data::FormValidator->validate( \%input_hash, \%dfv_profile);

    "validate()" provides a deprecated alternative to "check()". It has the
    same input syntax, but returns a four element array, described as
    follows

    valids
        This is a hash reference to the valid fields which were submitted in
        the data. The data may have been modified by the various filters
        specified.

    missings
        This is a reference to an array which contains the name of the
        missing fields. Those are the fields that the user forget to fill or
        filled with spaces. These fields may comes from the *required* list
        or the *dependencies* list.

    invalids
        This is a reference to an array which contains the name of the
        fields which failed one or more of their constraint checks.

        Fields defined with multiple constraints will have an array ref
        returned in the @invalids array instead of a string. The first
        element in this array is the name of the field, and the remaining
        fields are the names of the failed constraints.

    unknowns
        This is a list of fields which are unknown to the profile. Whether
        or not this indicates an error in the user input is application
        dependent.

  constraints (profile key)
    This is a supported but deprecated profile key. Using
    "constraint_methods" is recommended instead, which provides a simpler,
    more versatile interface.

     constraints => {
        cc_no      => {
            constraint  => "cc_number",
            params        => [ qw( cc_no cc_type ) ],
        },
        cc_type    => "cc_type",
        cc_exp    => "cc_exp",
      },

    A hash ref which contains the constraints that will be used to check
    whether or not the field contains valid data.

    The keys in this hash are field names. The values can be any of the
    following:

    o   A named constraint.

        Example:

         my_zipcode_field     => 'zip',

        See Data::FormValidator::Constraints for the details of which
        built-in constraints that are available.

  hashref style of specifying constraints
    Using a hash reference to specify a constraint is an older technique
    used to name a constraint or supply multiple parameters.

    Both of these interface issues are now better addressed with
    "constraint_methods" and "$self-\"name_this('foo')>.

     # supply multiple parameters
     cc_no  => {
         constraint  => "cc_number",
         params      => [ qw( cc_no cc_type ) ],
     },

     # name a constraint, useful for returning error messages
     last_name => {
         name => "ends_in_name",
         constraint => qr/_name$/,
     },

    Using a hash reference for a constraint permits the passing of multiple
    arguments. Required arguments are "constraint" or "constraint_method".
    Optional arguments are "name" and "params".

    A "name" on a constraints 'glues' the constraint to its error message in
    the validator profile (refer "msgs" section below). If no "name" is
    given then it will default to the value of "constraint" or
    "constraint_method" IF they are NOT a CODE ref or a RegExp ref.

    The "params" value is a reference to an array of the parameters to pass
    to the constraint method. If an element of the "params" list is a
    scalar, it is assumed to be naming a key of the %input_hash and that
    value is passed to the routine. If the parameter is a reference, then it
    is treated literally and passed unchanged to the routine.

    If you are using the older "constraint" over the new "constraint_method"
    then don't forget to include the name of the field to check in the
    "params" list. "constraint_method" provides access to this value via the
    "get_current_*" methods (refer Data::FormValidator::Constraints)

    For more details see "VALIDATING INPUT BASED ON MULTIPLE FIELDS".

  constraint_regexp_map (profile key)
    This is a supported by deprecated profile key. Using
    "constraint_methods_regexp_map" is recommended instead.

     constraint_regexp_map => {
         # All fields that end in _postcode have the 'postcode' constraint applied.
         qr/_postcode$/    => 'postcode',
     },

    A hash ref where the keys are the regular expressions to use and the
    values are the constraints to apply.

    If one or more constraints have already been defined for a given field
    using "constraints", constraint_regexp_map will add an additional
    constraint for that field for each regular expression that matches.

SEE ALSO
    Other modules in this distribution:

    Data::FormValidator::Constraints

    Data::FormValidator::Constraints::Dates

    Data::FormValidator::Constraints::Upload

    Data::FormValidator::ConstraintsFactory

    Data::FormValidator::Filters

    Data::FormValidator::Results

    A sample application by the maintainer:

    Validating Web Forms with Perl,
    <http://mark.stosberg.com/Tech/perl/form-validation/>

    Related modules:

    Data::FormValidator::Tutorial

    Data::FormValidator::Util::HTML

    CGI::Application::ValidateRM, a CGI::Application & Data::FormValidator
    glue module

    HTML::Template::Associate::FormValidator is designed to make some kinds
    of integration with HTML::Template easier.

    Params::Validate is useful for validating function parameters.

    Regexp::Common, Data::Types, Data::Verify, Email::Valid,
    String::Checker, CGI::ArgChecker, CGI::FormMagick::Validator,
    CGI::Validate

    Document Translations:

    Japanese: <http://perldoc.jp/docs/modules/>

    Distributions which include Data::FormValidator

    FreeBSD includes a port named p5-Data-FormValidator

    Debian GNU/Linux includes a port named libdata-formvalidator-perl

CREDITS
    Some of those input validation functions have been taken from MiniVend
    by Michael J. Heins.

    The credit card checksum validation was taken from contribution by Bruce
    Albrecht to the MiniVend program.

BUGS
    Bug reports and patches are welcome. Reports which include a failing
    Test::More style test are helpful will receive priority.

    <http://rt.cpan.org/NoAuth/Bugs.html?Dist=Data-FormValidator>

CONTRIBUTING
    This project is managed using the darcs source control system (
    http://www.darcs.net/ ). My darcs archive is here:
    http://mark.stosberg.com/darcs_hive/dfv/

    Support Mailing List

    If you have any questions, comments, or feature suggestions, post them
    to the support mailing list! To join the mailing list, visit

    <http://lists.sourceforge.net/lists/listinfo/cascade-dataform>

    Messages about DFV sent directly to the maintainer may be redirected
    here.

AUTHOR
    Parts Copyright 2001-2006 by Mark Stosberg <mark at summersault.com>,
    (Current Maintainer)

    Copyright (c) 1999 Francis J. Lacoste and iNsu Innovations Inc. All
    rights reserved. (Original Author)

    Parts Copyright 1996-1999 by Michael J. Heins <mike@heins.net>

    Parts Copyright 1996-1999 by Bruce Albrecht
    <bruce.albrecht@seag.fingerhut.com>

LICENSE
    This program is free software; you can redistribute it and/or modify it
    under the terms as perl itself.