Added deep recursion detection
[catagits/Catalyst-Runtime.git] / lib / Catalyst / Manual / Plugins.pod
CommitLineData
83b9e3a9 1=head1 NAME
2
3Catalyst::Manual::Plugins - Catalyst Plugins (and Components)
4
5=head1 DESCRIPTION
6
35e6ab34 7This section lists the some of the plugins and components that are
8available to extend the runtime functionality of Catalyst. The plugins
9are not distributed with Catalyst but should be available from CPAN.
10They typically require additional modules from CPAN.
83b9e3a9 11
12=head1 PLUGINS
13
14=head2 Catalyst::Plugin::Authentication::CDBI
15
35e6ab34 16L<Catalyst::Plugin::Authentication::CDBI> is a CDBI (C<Class::DBI>)
17authentication plugin. Note that it requires a session plugin.
83b9e3a9 18
19=head2 Catalyst::Plugin::Email
20
35e6ab34 21L<Catalyst::Plugin::Email> sends email with Catalyst and L<Email::Send>
22and L<Email::MIME::Creator>.
83b9e3a9 23
24=head2 Catalyst::Plugin::FillInForm
25
35e6ab34 26L<Catalyst::Plugin::FillInForm> is plugin for Catalyst based on
27C<HTML::FillInForm>, which describes itself as a module to automatically
28insert data from a previous HTML form into the HTML input, textarea,
29radio buttons, checkboxes, and select tags. C<HTML::FillInForm> is a
30subclass of C<HTML::Parser> and uses it to parse the HTML and insert the
31values into the form tags.
83b9e3a9 32
33=head2 Catalyst::Plugin::FormValidator
34
35e6ab34 35L<Catalyst::Plugin::FormValidator> is a form validator plugin that uses
36L<Data::FormValidator> to validate and set up form data from your
37request parameters. It's a quite thin wrapper around that module, so
38most of the relevant information can be found there.
83b9e3a9 39
40
41=head2 Catalyst::Plugin::I18N
42
35e6ab34 43L<Catalyst::Plugin::I18N> is an internationalization plugin for
44Catalyst. Supports C<mo>/C<po> files and Maketext classes under your
45application's I18N namespace.
83b9e3a9 46
47
48=head2 Catalyst::Plugin::Pluggable
49
35e6ab34 50L<Catalyst::Plugin::Pluggable> is a plugin for pluggable Catalyst
51applications.
83b9e3a9 52
53=head2 Catalyst::Plugin::Prototype
54
35e6ab34 55L<Catalyst::Plugin::Prototype> is a plugin for the Prototype JavaScript
56library. This Plugin allows you to easily implement AJAX functionality
57without actually knowing Javascript.
83b9e3a9 58
59=head2 Catalyst::Plugin::Session::FastMmap
60
35e6ab34 61L<Catalyst::Plugin::Session::FastMmap> is a session plugin for Catalyst
62based on C<Cache::FastMMap>, which uses an mmap'ed file to act as a
63shared memory interprocess cache.
83b9e3a9 64
65
66=head2 Catalyst::Plugin::Static
67
35e6ab34 68L<Catalyst::Plugin::Static> is a plugin to serve static files from C<<
69$c->config->{root} >>/<< action >>/.
83b9e3a9 70
71
665dadd4 72=head2 Catalyst::Plugin::SubRequest
73
35e6ab34 74L<Catalyst::Plugin::SubRequest> is a plugin to allow subrequests to
75actions to be made within Catalyst. Nice for portal software and such.
665dadd4 76
77
83b9e3a9 78=head2 Catalyst::Plugin::Textile
79
35e6ab34 80L<Catalyst::Plugin::Textile> is a persistent Textile processor for
81Catalyst that uses C<Text::Textile>, a Perl-based implementation of Dean
82Allen's Textile syntax. Textile is shorthand for doing common formatting
83tasks (see L<http://textism.com>).
83b9e3a9 84
85
86=head2 Catalyst::Plugin::XMLRPC
87
35e6ab34 88L<Catalyst::Plugin::XMLRPC> plugin allows your Controller class to
89dispatch XMLRPC methods from its own class.
83b9e3a9 90
91
92=head1 COMPONENT MODULES
93
94=head2 Catalyst::Model::CDBI
95
35e6ab34 96L<Catalyst::Model::CDBI> is the C<Class::DBI> (CDBI) module class. It
4911f47a 97is built on top of C<Class::DBI::Loader>, which automates the
98definition of C<Class::DBI> sub-classes by scanning the underlying
99table schemas, setting up columns and primary keys.
83b9e3a9 100
386777dc 101=head2 Catalyst::Model::CDBI::Plain
102
103L<Catalyst::Model::CDBI::Plain> is a neutral interface to the
104C<Class::DBI> module, which does not attempt to automate table
105setup. It allows the user to manually set up C<Class::DBI>
106classes, either by doing so within the Catalyst model classes
107themselves, or by inheriting from existing C<Class::DBI>
108classes.
109
83b9e3a9 110=head2 Catalyst::Model::CDBI::CRUD
111
35e6ab34 112L<Catalyst::Model::CDBI::CRUD> is a subclass of
abea2aaa 113C<Catalyst::Model::CDBI> with additional CRUD (create, replace,
114update, delete) methods.
83b9e3a9 115
116
4911f47a 117=head2 Catalyst::View::TT
83b9e3a9 118
35e6ab34 119L<Catalyst::View::TT> is a Template Toolkit view. See
120L<Template::Manual>.
83b9e3a9 121
abea2aaa 122=head2 Catalyst::View::Mason
123
35e6ab34 124L<Catalyst::View::Mason> allows you to render your stash using
125L<HTML::Mason>.
83b9e3a9 126
127=head1 AUTHOR
128
129Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
4911f47a 130Marcus Ramberg E<lt>mramberg@cpan.orgE<gt>
83b9e3a9 131
132=head1 COPYRIGHT
133
134This program is free software, you can redistribute it and/or modify it under
135the same terms as Perl itself.