.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Mojolicious::Validator 3pm"
.TH Mojolicious::Validator 3pm 2024-05-15 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Mojolicious::Validator \- Validate values
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use Mojolicious::Validator;
\&
\&  my $validator = Mojolicious::Validator\->new;
\&  my $v = $validator\->validation;
\&  $v\->input({foo => \*(Aqbar\*(Aq});
\&  $v\->required(\*(Aqfoo\*(Aq)\->like(qr/ar$/);
\&  say $v\->param(\*(Aqfoo\*(Aq);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Mojolicious::Validator validates values for Mojolicious.
.SH CHECKS
.IX Header "CHECKS"
These validation checks are available by default.
.SS equal_to
.IX Subsection "equal_to"
.Vb 1
\&  $v = $v\->equal_to(\*(Aqfoo\*(Aq);
.Ve
.PP
String value needs to be equal to the value of another field.
.SS in
.IX Subsection "in"
.Vb 1
\&  $v = $v\->in(\*(Aqfoo\*(Aq, \*(Aqbar\*(Aq, \*(Aqbaz\*(Aq);
.Ve
.PP
String value needs to match one of the values in the list.
.SS like
.IX Subsection "like"
.Vb 1
\&  $v = $v\->like(qr/^[A\-Z]/);
.Ve
.PP
String value needs to match the regular expression.
.SS num
.IX Subsection "num"
.Vb 5
\&  $v = $v\->num;
\&  $v = $v\->num(2, 5);
\&  $v = $v\->num(\-3, 7);
\&  $v = $v\->num(2, undef);
\&  $v = $v\->num(undef, 5);
.Ve
.PP
String value needs to be a non-fractional number (positive or negative) and if provided in the given range.
.SS size
.IX Subsection "size"
.Vb 3
\&  $v = $v\->size(2, 5);
\&  $v = $v\->size(2, undef);
\&  $v = $v\->size(undef, 5);
.Ve
.PP
String value length or size of Mojo::Upload object in bytes needs to be between these two values.
.SS upload
.IX Subsection "upload"
.Vb 1
\&  $v = $v\->upload;
.Ve
.PP
Value needs to be a Mojo::Upload object, representing a file upload.
.SH FILTERS
.IX Header "FILTERS"
These filters are available by default.
.SS comma_separated
.IX Subsection "comma_separated"
.Vb 1
\&  $v = $v\->optional(\*(Aqfoo\*(Aq, \*(Aqcomma_separated\*(Aq);
.Ve
.PP
Split string of comma separated values into separate values.
.SS not_empty
.IX Subsection "not_empty"
.Vb 1
\&  $v = $v\->optional(\*(Aqfoo\*(Aq, \*(Aqnot_empty\*(Aq);
.Ve
.PP
Remove empty string values and treat them as if they had not been submitted.
.SS trim
.IX Subsection "trim"
.Vb 1
\&  $v = $v\->optional(\*(Aqfoo\*(Aq, \*(Aqtrim\*(Aq);
.Ve
.PP
Trim whitespace characters from both ends of string value with "trim" in Mojo::Util.
.SH ATTRIBUTES
.IX Header "ATTRIBUTES"
Mojolicious::Validator implements the following attributes.
.SS checks
.IX Subsection "checks"
.Vb 2
\&  my $checks = $validator\->checks;
\&  $validator = $validator\->checks({size => sub ($v, $name, $value, @args) {...}});
.Ve
.PP
Registered validation checks, by default only "equal_to", "in", "like", "num", "size" and
"upload" are already defined.
.SS filters
.IX Subsection "filters"
.Vb 2
\&  my $filters = $validator\->filters;
\&  $validator  = $validator\->filters({trim => sub {...}});
.Ve
.PP
Registered filters, by default only "comma_separated", "not_empty" and "trim" are already defined.
.SH METHODS
.IX Header "METHODS"
Mojolicious::Validator inherits all methods from Mojo::Base and implements the following new ones.
.SS add_check
.IX Subsection "add_check"
.Vb 1
\&  $validator = $validator\->add_check(size => sub ($v, $name, $value, @args) {...});
.Ve
.PP
Register a validation check.
.PP
.Vb 4
\&  $validator\->add_check(foo => sub ($v, $name, $value, @args) {
\&    ...
\&    return undef;
\&  });
.Ve
.SS add_filter
.IX Subsection "add_filter"
.Vb 1
\&  $validator = $validator\->add_filter(trim => sub ($v, $name, $value) {...});
.Ve
.PP
Register a new filter.
.PP
.Vb 4
\&  $validator\->add_filter(foo => sub ($v, $name, $value) {
\&    ...
\&    return $value;
\&  });
.Ve
.SS new
.IX Subsection "new"
.Vb 1
\&  my $validator = Mojolicious::Validator\->new;
.Ve
.PP
Construct a new Mojolicious::Validator object.
.SS validation
.IX Subsection "validation"
.Vb 1
\&  my $v = $validator\->validation;
.Ve
.PP
Build Mojolicious::Validator::Validation object to perform validations.
.PP
.Vb 4
\&  my $v = $validator\->validation;
\&  $v\->input({foo => \*(Aqbar\*(Aq});
\&  $v\->required(\*(Aqfoo\*(Aq)\->size(1, 5);
\&  say $v\->param(\*(Aqfoo\*(Aq);
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Mojolicious, Mojolicious::Guides, <https://mojolicious.org>.