.\" -*- 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 "HTML::FormFu::Plugin 3pm"
.TH HTML::FormFu::Plugin 3pm 2024-04-10 "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
HTML::FormFu::Plugin \- base class for plugins
.SH VERSION
.IX Header "VERSION"
version 2.07
.SS DESCRIPTION
.IX Subsection "DESCRIPTION"
Plugins can be added to a form or any element to modify their behaviour.
Some plugins should only be added to either a form, or an element, depending
on their design.
.SH METHODS
.IX Header "METHODS"
Plugins can override any of the following method stubs.
.SS process
.IX Subsection "process"
Only plugins added to a form or a field element inheriting from
HTML::FormFu::Role::Element::Field will have their \f(CW\*(C`process\*(C'\fR method run.
.PP
For form plugins, is called during "process" in HTML::FormFu, before \f(CW\*(C`process\*(C'\fR
is called on any elements.
.PP
For field plugins, is called during the field's \f(CW\*(C`process\*(C'\fR call.
.SS pre_process
.IX Subsection "pre_process"
For form plugins, is called immediately after \f(CW\*(C`pre_process\*(C'\fR
is run on the elements.
.PP
For element plugins, is called before \f(CW\*(C`pre_process\*(C'\fR is run on form plugins.
.SS post_process
.IX Subsection "post_process"
For form plugins, is called immediately before "process" in HTML::FormFu
returns.
.PP
For element plugins, is called before \f(CW\*(C`post_process\*(C'\fR is run on form plugins.
.SS render
.IX Subsection "render"
Only plugins added to a form will have their \f(CW\*(C`render\*(C'\fR method run.
.PP
Is called during "render" in HTML::FormFu before the
"render_method" in HTML::FormFu is called.
.SS post_render
.IX Subsection "post_render"
Only plugins added to a form will have their \f(CW\*(C`post_render\*(C'\fR method run.
.PP
Is called during "render" in HTML::FormFu immediately before
"render" in HTML::FormFu return.
.PP
Is passed a reference to the return value of "render_method" in HTML::FormFu.
.SH "CORE PLUGINS"
.IX Header "CORE PLUGINS"
.IP HTML::FormFu::Plugin::StashValid 4
.IX Item "HTML::FormFu::Plugin::StashValid"
.SH AUTHOR
.IX Header "AUTHOR"
Carl Franks, \f(CW\*(C`cfranks@cpan.org\*(C'\fR
.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.