1HTML::FormFu::Filter(3)User Contributed Perl DocumentatioHnTML::FormFu::Filter(3)
2
3
4

NAME

6       HTML::FormFu::Filter - Filter Base Class
7

VERSION

9       version 2.07
10

SYNOPSIS

12           ---
13           elements:
14             - type: Text
15               name: foo
16               filters:
17                 - type: Encode
18                   candidates:
19                     - utf8
20                     - Hebrew
21             - type: Text
22               name: bar
23               filters:
24                 - LowerCase
25                 - Encode
26           filters:
27             - TrimEdges
28

DESCRIPTION

30       "filters()" and "filter" can be called on any form, block element
31       (includes fieldsets) or field element.
32
33       If called on a field element, no "name" argument should be passed.
34
35       If called on a form or block element, if no "name" argument is
36       provided, a new filter is created for and added to every field on that
37       form or block.
38
39       See "FORM LOGIC AND VALIDATION" in HTML::FormFu for further details.
40

METHODS

42   type
43       Returns the "type" argument originally used to create the filter.
44
45   localise_args
46       Provide arguments that should be passed to localize to replace "[_1]",
47       "[_2]", etc. in the localized string.
48
49   parent
50       Returns the HTML::FormFu::Role::Element::Field object that the filter
51       is associated with.
52
53   get_parent
54       Arguments: \%options
55
56       Traverses the parent hierarchy, returning the first parent that matches
57       the supplied options.
58
59   form
60       Returns the HTML::FormFu object that the filter's field is attached to.
61
62   name
63       Shorthand for "$filter->parent->name"
64

CORE FILTERS

66       HTML::FormFu::Filter::Callback
67       HTML::FormFu::Filter::CompoundJoin
68       HTML::FormFu::Filter::CompoundSprintf
69       HTML::FormFu::Filter::CopyValue
70       HTML::FormFu::Filter::Default
71       HTML::FormFu::Filter::Encode
72       HTML::FormFu::Filter::ForceListValue
73       HTML::FormFu::Filter::FormatNumber
74       HTML::FormFu::Filter::HTMLEscape
75       HTML::FormFu::Filter::HTMLScrubber
76       HTML::FormFu::Filter::LowerCase
77       HTML::FormFu::Filter::NonNumeric
78       HTML::FormFu::Filter::Regex
79       HTML::FormFu::Filter::Split
80       HTML::FormFu::Filter::TrimEdges
81       HTML::FormFu::Filter::UpperCase
82       HTML::FormFu::Filter::Whitespace
83

FILTER BASE CLASSES

85       The following are base classes for other filters, and generally needn't
86       be used directly.
87
88       HTML::FormFu::Filter::_Compound
89

AUTHOR

91       Carl Franks, "cfranks@cpan.org"
92
93       Based on the original source code of HTML::Widget::Filter, by Sebastian
94       Riedel.
95

LICENSE

97       This library is free software, you can redistribute it and/or modify it
98       under the same terms as Perl itself.
99

AUTHOR

101       Carl Franks <cpan@fireartist.com>
102

104       This software is copyright (c) 2018 by Carl Franks.
105
106       This is free software; you can redistribute it and/or modify it under
107       the same terms as the Perl 5 programming language system itself.
108
109
110
111perl v5.28.1                      2018-12-14           HTML::FormFu::Filter(3)
Impressum