1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
|
use strict;
package HTML::FormFu::Plugin;
$HTML::FormFu::Plugin::VERSION = '2.07';
# ABSTRACT: base class for plugins
use Moose;
use MooseX::Attribute::Chained;
with 'HTML::FormFu::Role::HasParent', 'HTML::FormFu::Role::Populate';
use HTML::FormFu::ObjectUtil qw( form parent );
has type => ( is => 'rw', traits => ['Chained'] );
sub pre_process { }
sub process { }
sub post_process { }
sub render { }
sub post_render { }
sub clone {
my ($self) = @_;
my %new = %$self;
return bless \%new, ref $self;
}
__PACKAGE__->meta->make_immutable;
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
HTML::FormFu::Plugin - base class for plugins
=head1 VERSION
version 2.07
=head2 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.
=head1 METHODS
Plugins can override any of the following method stubs.
=head2 process
Only plugins added to a form or a field element inheriting from
L<HTML::FormFu::Role::Element::Field> will have their C<process> method run.
For form plugins, is called during L<HTML::FormFu/process>, before C<process>
is called on any elements.
For field plugins, is called during the field's C<process> call.
=head2 pre_process
For form plugins, is called immediately after C<pre_process>
is run on the elements.
For element plugins, is called before C<pre_process> is run on form plugins.
=head2 post_process
For form plugins, is called immediately before L<HTML::FormFu/process>
returns.
For element plugins, is called before C<post_process> is run on form plugins.
=head2 render
Only plugins added to a form will have their C<render> method run.
Is called during L<HTML::FormFu/render> before the
L<HTML::FormFu/render_method> is called.
=head2 post_render
Only plugins added to a form will have their C<post_render> method run.
Is called during L<HTML::FormFu/render> immediately before
L<HTML::FormFu/render> return.
Is passed a reference to the return value of L<HTML::FormFu/render_method>.
=head1 CORE PLUGINS
=over
=item L<HTML::FormFu::Plugin::StashValid>
=back
=head1 AUTHOR
Carl Franks, C<cfranks@cpan.org>
=head1 LICENSE
This library is free software, you can redistribute it and/or modify it under
the same terms as Perl itself.
=head1 AUTHOR
Carl Franks <cpan@fireartist.com>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2018 by Carl Franks.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
|