1Validation::Class::DireUcsteirveCso(n3t)ributed Perl DocVuamleindtaattiioonn::Class::Directives(3)
2
6 Validation::Class::Directives - Validation::Class Core Directives
7 Registry
8
10 version 7.900059
11
13 Validation::Class::Directives provides a collection of installed
14 Validation::Class directives. This class inherits from
15 Validation::Class::Mapping. Please look at Validation::Class::Directive
16 for information of developing your own directives.
17
19 The following is a list of core directives that get installed
20 automatically with Validation::Class and can be used to jump-start your
21 data validation initiative. Please Note! The purpose of the core
22 directives is merely to provide a reasonable layer of protection
23 against bad/malformed data, the validators are not very sophisticated
24 and were created using a minimal level of strictness (e.g. the email
25 and hostname directives do not perform a hostname lookup nor does the
26 email directive conform to the RFC specification).
27 Various applications have varied levels of strictness regarding various
29 types of input (e.g. a hospital API may require a more sophisticated
30 SSN validation than that of a department of education API; likewise; an
31 email service API may require a more sophisticated email validation
32 than that of a file sharing API). Validation::Class does not attempt
33 to provide validators for all levels of strictness and the core
34 directives exist to support typical use-cases with a minimal level of
35 strictness.
36 alias
38 The alias directive is provided by Validation::Class::Directive::Alias
39 and handles parameter aliases.
40 between
42 The between directive is provided by
43 Validation::Class::Directive::Between and handles numeric range
44 validation.
45 city
47 The city directive is provided by Validation::Class::Directive::City
48 and handles city/area validation for cities in the USA.
49 creditcard
51 The creditcard directive is provided by
52 Validation::Class::Directive::Creditcard and handles validation for
53 american express, bankcard, diners card, discover card, electron,
54 enroute, jcb, maestro, mastercard, solo, switch, visa and voyager
55 credit cards.
56 date
58 The date directive is provided by Validation::Class::Directive::Date
59 and handles validation of simple date formats.
60 decimal
62 The decimal directive is provided by
63 Validation::Class::Directive::Decimal and handles validation of
64 floating point integers.
65 default
67 The default directive is provided by
68 Validation::Class::Directive::Default and hold the value which should
69 be used if no parameter is supplied.
70 depends_on
72 The depends_on directive is provided by
73 Validation::Class::Directive::DependsOn and validates the existence of
74 dependent parameters.
75 email
77 The email directive is provided by Validation::Class::Directive::Email
78 and checks the validity of email address specified by the associated
79 parameters within reason. Please note, the email directive does not
80 perform a host lookup nor does it conform to the RFC specification.
81 error
83 The error directive is provided by Validation::Class::Directive::Error
84 and holds the error message that will supersede any other error
85 messages that attempt to register errors at the field-level for the
86 associated field.
87 errors
89 The errors directive is provided by
90 Validation::Class::Directive::Errors and is a container (object) which
91 holds error message registered at the field-level for the associated
92 field.
93 filtering
95 The filtering directive is provided by
96 Validation::Class::Directive::Filtering and specifies whether filtering
97 and sanitation should occur as a pre-process or post-process.
98 filters
100 The filters directive is provided by
101 Validation::Class::Directive::Filters and specifies which filter should
102 be executed on the associated field.
103 hostname
105 The hostname directive is provided by
106 Validation::Class::Directive::Hostname and handles validatation of
107 server hostnames.
108 label
110 The label directive is provided by Validation::Class::Directive::Label
111 and holds a user-friendly string (name) representing the associated
112 field.
113 length
115 The length directive is provided by
116 Validation::Class::Directive::Length and validates the exact length of
117 the associated parameters.
118 matches
120 The matches directive is provided by
121 Validation::Class::Directive::Matches and validates whether the value
122 of the dependent parameters matches that of the associated field.
123 max_alpha
125 The max_alpha directive is provided by
126 Validation::Class::Directive::MaxAlpha and validates the length of
127 alphabetic characters in the associated parameters.
128 max_digits
130 The max_digits directive is provided by
131 Validation::Class::Directive::MaxDigits and validates the length of
132 numeric characters in the associated parameters.
133 max_length
135 The max_length directive is provided by
136 Validation::Class::Directive::MaxLength and validates the length of all
137 characters in the associated parameters.
138 max_sum
140 The max_sum directive is provided by
141 Validation::Class::Directive::MaxSum and validates the numeric value of
142 the associated parameters.
143 max_symbols
145 The max_symbols directive is provided by
146 Validation::Class::Directive::MaxSymbols and validates the length of
147 non-alphanumeric characters in the associated parameters.
148 messages
150 The messages directive is provided by
151 Validation::Class::Directive::Messages and is a container (object)
152 which holds error message which will supersede the default error
153 messages of the associated directives.
154 min_alpha
156 The min_alpha directive is provided by
157 Validation::Class::Directive::MinAlpha and validates the length of
158 alphabetic characters in the associated parameters.
159 min_digits
161 The min_digits directive is provided by
162 Validation::Class::Directive::MinDigits and validates the length of
163 numeric characters in the associated parameters.
164 min_length
166 The min_length directive is provided by
167 Validation::Class::Directive::MinLength and validates the length of all
168 characters in the associated parameters.
169 min_sum
171 The min_sum directive is provided by
172 Validation::Class::Directive::MinSum and validates the numeric value of
173 the associated parameters.
174 min_symbols
176 The min_symbols directive is provided by
177 Validation::Class::Directive::MinSymbols and validates the length of
178 non-alphanumeric characters in the associated parameters.
179 mixin
181 The mixin directive is provided by Validation::Class::Directive::Mixin
182 and determines what directive templates will be merged with the
183 associated field.
184 mixin_field
186 The mixin_field directive is provided by
187 Validation::Class::Directive::MixinField and determines what fields
188 will be used as templates and merged with the associated field.
189 multiples
191 The multiples directive is provided by
192 Validation::Class::Directive::Multiples and validates whether the
193 associated parameters may contain a multi-value (an array of strings).
194 name
196 The name directive is provided by Validation::Class::Directive::Name
197 and merely holds the name of the associated field. This value is
198 populated automatically.
199 options
201 The options directive is provided by
202 Validation::Class::Directive::Options and holds an enumerated list of
203 values to be validated against the associated parameters.
204 pattern
206 The pattern directive is provided by
207 Validation::Class::Directive::Pattern and handles validation of simple
208 patterns and complex regular expressions.
209 readonly
211 The readonly directive is provided by
212 Validation::Class::Directive::Readonly and determines whether the
213 associated parameters should be ignored.
214 required
216 The required directive is provided by
217 Validation::Class::Directive::Required and handles validation of supply
218 and demand.
219 ssn
221 The ssn directive is provided by Validation::Class::Directive::SSN and
222 handles validation of social security numbers in the USA.
223 state
225 The state directive is provided by Validation::Class::Directive::State
226 and handles state validation for states in the USA.
227 telephone
229 The telephone directive is provided by
230 Validation::Class::Directive::Telephone and handles telephone number
231 validation for the USA and North America.
232 time
234 The time directive is provided by Validation::Class::Directive::Time
235 and handles validation for standard time formats.
236 toggle
238 The toggle directive is provided by
239 Validation::Class::Directive::Toggle and used internally to handle
240 validation of per-validation-event requirements.
241 uuid
243 The uuid directive is provided by Validation::Class::Directive::UUID
244 and handles validation of Globally/Universally Unique Identifiers.
245 validation
247 The validation directive is provided by
248 Validation::Class::Directive::Validation and used to execute user-
249 defined validation routines.
250 value
252 The value directive is provided by Validation::Class::Directive::value
253 and hold the absolute value of the associated field.
254 zipcode
256 The zipcode directive is provided by
257 Validation::Class::Directive::Zipcode and handles postal-code
258 validation for areas in the USA and North America.
259
261 Al Newkirk <anewkirk@ana.io>
262
264 This software is copyright (c) 2011 by Al Newkirk.
265 This is free software; you can redistribute it and/or modify it under
267 the same terms as the Perl 5 programming language system itself.
268perl v5.36.0 2023-04-03 Validation::Class::Directives(3)