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
|
# ABSTRACT: Help Directive for Validation Class Field Definitions
package Validation::Class::Directive::Help;
use strict;
use warnings;
use base 'Validation::Class::Directive';
use Validation::Class::Util;
our $VERSION = '7.900057'; # VERSION
has 'mixin' => 0;
has 'field' => 1;
has 'multi' => 0;
sub normalize {
my ($self, $proto, $field) = @_;
# static help-text may contain multiline strings for the sake of
# aesthetics, flatten them here
if (defined $field->{help}) {
$field->{help} =~ s/^[\n\s\t\r]+//g;
$field->{help} =~ s/[\n\s\t\r]+$//g;
$field->{help} =~ s/[\n\s\t\r]+/ /g;
}
return $self;
}
1;
__END__
=pod
=head1 NAME
Validation::Class::Directive::Help - Help Directive for Validation Class Field Definitions
=head1 VERSION
version 7.900057
=head1 SYNOPSIS
use Validation::Class::Simple;
my $rules = Validation::Class::Simple->new(
fields => {
username => {
help => q/A username was automatically generated for you
at the time you registered your account. Check your email
client for additional instructions./
}
}
);
=head1 DESCRIPTION
Validation::Class::Directive::Help is a core validation class field
directive that holds the help-text statement(s) to be associated with specific
fields which are useful when rendering form fields or when developing RESTful
API resources.
=head1 AUTHOR
Al Newkirk <anewkirk@ana.io>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2011 by Al Newkirk.
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
|
