.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 "HTML::FormFu::Filter 3pm"
.TH HTML::FormFu::Filter 3pm "2019-01-12" "perl v5.28.1" "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"
HTML::FormFu::Filter \- Filter Base Class
.SH "VERSION"
.IX Header "VERSION"
version 2.07
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 10
\&    \-\-\-
\&    elements:
\&      \- type: Text
\&        name: foo
\&        filters:
\&          \- type: Encode
\&            candidates:
\&              \- utf8
\&              \- Hebrew
\&      \- type: Text
\&        name: bar
\&        filters:
\&          \- LowerCase
\&          \- Encode
\&    filters:
\&      \- TrimEdges
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`filters()\*(C'\fR and \f(CW\*(C`filter\*(C'\fR can be called on any form,
block element (includes fieldsets) or
field element.
.PP
If called on a field element, no \f(CW\*(C`name\*(C'\fR argument should be passed.
.PP
If called on a form or
block element, if no \f(CW\*(C`name\*(C'\fR argument is
provided, a new filter is created for and added to every field on that form
or block.
.PP
See \*(L"\s-1FORM LOGIC AND VALIDATION\*(R"\s0 in HTML::FormFu for further details.
.SH "METHODS"
.IX Header "METHODS"
.SS "type"
.IX Subsection "type"
Returns the \f(CW\*(C`type\*(C'\fR argument originally used to create the filter.
.SS "localise_args"
.IX Subsection "localise_args"
Provide arguments that should be passed to localize
to replace \f(CW\*(C`[_1]\*(C'\fR, \f(CW\*(C`[_2]\*(C'\fR, etc. in the localized string.
.SS "parent"
.IX Subsection "parent"
Returns the HTML::FormFu::Role::Element::Field object that the filter is
associated with.
.SS "get_parent"
.IX Subsection "get_parent"
Arguments: \e%options
.PP
Traverses the parent hierarchy, returning the first parent that matches the
supplied options.
.SS "form"
.IX Subsection "form"
Returns the HTML::FormFu object that the filter's field is attached to.
.SS "name"
.IX Subsection "name"
Shorthand for \f(CW\*(C`$filter\->parent\->name\*(C'\fR
.SH "CORE FILTERS"
.IX Header "CORE FILTERS"
.IP "HTML::FormFu::Filter::Callback" 4
.IX Item "HTML::FormFu::Filter::Callback"
.PD 0
.IP "HTML::FormFu::Filter::CompoundJoin" 4
.IX Item "HTML::FormFu::Filter::CompoundJoin"
.IP "HTML::FormFu::Filter::CompoundSprintf" 4
.IX Item "HTML::FormFu::Filter::CompoundSprintf"
.IP "HTML::FormFu::Filter::CopyValue" 4
.IX Item "HTML::FormFu::Filter::CopyValue"
.IP "HTML::FormFu::Filter::Default" 4
.IX Item "HTML::FormFu::Filter::Default"
.IP "HTML::FormFu::Filter::Encode" 4
.IX Item "HTML::FormFu::Filter::Encode"
.IP "HTML::FormFu::Filter::ForceListValue" 4
.IX Item "HTML::FormFu::Filter::ForceListValue"
.IP "HTML::FormFu::Filter::FormatNumber" 4
.IX Item "HTML::FormFu::Filter::FormatNumber"
.IP "HTML::FormFu::Filter::HTMLEscape" 4
.IX Item "HTML::FormFu::Filter::HTMLEscape"
.IP "HTML::FormFu::Filter::HTMLScrubber" 4
.IX Item "HTML::FormFu::Filter::HTMLScrubber"
.IP "HTML::FormFu::Filter::LowerCase" 4
.IX Item "HTML::FormFu::Filter::LowerCase"
.IP "HTML::FormFu::Filter::NonNumeric" 4
.IX Item "HTML::FormFu::Filter::NonNumeric"
.IP "HTML::FormFu::Filter::Regex" 4
.IX Item "HTML::FormFu::Filter::Regex"
.IP "HTML::FormFu::Filter::Split" 4
.IX Item "HTML::FormFu::Filter::Split"
.IP "HTML::FormFu::Filter::TrimEdges" 4
.IX Item "HTML::FormFu::Filter::TrimEdges"
.IP "HTML::FormFu::Filter::UpperCase" 4
.IX Item "HTML::FormFu::Filter::UpperCase"
.IP "HTML::FormFu::Filter::Whitespace" 4
.IX Item "HTML::FormFu::Filter::Whitespace"
.PD
.SH "FILTER BASE CLASSES"
.IX Header "FILTER BASE CLASSES"
The following are base classes for other filters, and generally needn't be
used directly.
.IP "HTML::FormFu::Filter::_Compound" 4
.IX Item "HTML::FormFu::Filter::_Compound"
.SH "AUTHOR"
.IX Header "AUTHOR"
Carl Franks, \f(CW\*(C`cfranks@cpan.org\*(C'\fR
.PP
Based on the original source code of HTML::Widget::Filter, by
Sebastian Riedel.
.SH "LICENSE"
.IX Header "LICENSE"
This library is free software, you can redistribute it and/or modify it under
the same terms as Perl itself.
.SH "AUTHOR"
.IX Header "AUTHOR"
Carl Franks <cpan@fireartist.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2018 by Carl Franks.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.