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

NAME

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

SYNOPSIS

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

DESCRIPTION

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

METHODS

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

CORE FILTERS

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

FILTER BASE CLASSES

81       The following are base classes for other filters, and generally needn't
82       be used directly.
83
84       HTML::FormFu::Filter::_Compound
85

AUTHOR

87       Carl Franks, "cfranks@cpan.org"
88
89       Based on the original source code of HTML::Widget::Filter, by Sebastian
90       Riedel.
91

LICENSE

93       This library is free software, you can redistribute it and/or modify it
94       under the same terms as Perl itself.
95
96
97
98perl v5.12.1                      2010-05-23           HTML::FormFu::Filter(3)