Commit | Line | Data |
83b9e3a9 |
1 | =head1 NAME |
2 | |
3 | Catalyst::Manual::Plugins - Catalyst Plugins (and Components) |
4 | |
5 | =head1 DESCRIPTION |
6 | |
35e6ab34 |
7 | This section lists the some of the plugins and components that are |
8 | available to extend the runtime functionality of Catalyst. The plugins |
9 | are not distributed with Catalyst but should be available from CPAN. |
c42f5bbf |
10 | They typically require additional modules from CPAN. We will try to |
11 | keep this document up to date, but please check CPAN directly for |
12 | the latest and greatest. |
83b9e3a9 |
13 | |
14 | =head1 PLUGINS |
15 | |
16 | =head2 Catalyst::Plugin::Authentication::CDBI |
17 | |
35e6ab34 |
18 | L<Catalyst::Plugin::Authentication::CDBI> is a CDBI (C<Class::DBI>) |
19 | authentication plugin. Note that it requires a session plugin. |
83b9e3a9 |
20 | |
c42f5bbf |
21 | =head2 Catalyst::Plugin::Authentication::LDAP |
22 | |
23 | L<Catalyst::Plugin::Authentication::LDAP> is a plugin allowing you |
24 | to authenticate your web users using an LDAP server. |
25 | |
83b9e3a9 |
26 | =head2 Catalyst::Plugin::Email |
27 | |
35e6ab34 |
28 | L<Catalyst::Plugin::Email> sends email with Catalyst and L<Email::Send> |
29 | and L<Email::MIME::Creator>. |
83b9e3a9 |
30 | |
c42f5bbf |
31 | =head2 Catalyst::Plugin::Browser |
32 | |
33 | L<Catalyst::Plugin::Browser> extends L<Catalyst::Request> by adding the |
34 | capability of browser detection. It returns an instance of |
35 | L<HTTP::BrowserDetect>, which lets you get information from the client's |
36 | user agent. |
37 | |
38 | =head2 Catalyst::Plugin::Compress::Zlib |
39 | |
40 | L<Catalyst::Plugin::Compress::Zlib> supplies Zlib compression for |
41 | Catalyst. |
42 | |
43 | =head2 Catalyst::Plugin::Compress::Bzip2 |
44 | |
45 | L<Catalyst::Plugin::Compress::Bzip2> compresses a response using |
46 | bzip compression. |
47 | |
83b9e3a9 |
48 | =head2 Catalyst::Plugin::FillInForm |
49 | |
35e6ab34 |
50 | L<Catalyst::Plugin::FillInForm> is plugin for Catalyst based on |
51 | C<HTML::FillInForm>, which describes itself as a module to automatically |
52 | insert data from a previous HTML form into the HTML input, textarea, |
53 | radio buttons, checkboxes, and select tags. C<HTML::FillInForm> is a |
54 | subclass of C<HTML::Parser> and uses it to parse the HTML and insert the |
55 | values into the form tags. |
83b9e3a9 |
56 | |
57 | =head2 Catalyst::Plugin::FormValidator |
58 | |
35e6ab34 |
59 | L<Catalyst::Plugin::FormValidator> is a form validator plugin that uses |
60 | L<Data::FormValidator> to validate and set up form data from your |
61 | request parameters. It's a quite thin wrapper around that module, so |
62 | most of the relevant information can be found there. |
83b9e3a9 |
63 | |
c42f5bbf |
64 | =head2 Catalyst::Plugin::Geography |
65 | |
66 | L<Catalyst::Plugin::Geography> allows you to retrieve various kinds |
67 | of geographical information. You can retrieve the country or code from |
68 | the current user, from a given IP address, or from a given hostname. |
83b9e3a9 |
69 | |
70 | =head2 Catalyst::Plugin::I18N |
71 | |
35e6ab34 |
72 | L<Catalyst::Plugin::I18N> is an internationalization plugin for |
73 | Catalyst. Supports C<mo>/C<po> files and Maketext classes under your |
74 | application's I18N namespace. |
83b9e3a9 |
75 | |
62d40b4c |
76 | =head2 Catalyst::Plugin::Observe |
77 | |
78 | L<Catalyst::Plugin::Observe> provides the ability to register AOP-like |
79 | callbacks to specific Engine events. Subclasses L<Class::Publisher>. |
80 | |
c74caf1d |
81 | =head2 Catalyst::Plugin::PageCache |
82 | |
83 | L<Catalyst::Plugin::PageCache> helps improve the performance of slow or |
84 | frequently accessed pages by caching the entire output of your page. |
85 | Subsequent requests to the page will receive the page very quickly from |
86 | cache. Note: At the moment it should be regarded as I<highly |
87 | experimental>. |
88 | |
83b9e3a9 |
89 | =head2 Catalyst::Plugin::Pluggable |
90 | |
35e6ab34 |
91 | L<Catalyst::Plugin::Pluggable> is a plugin for pluggable Catalyst |
92 | applications. |
83b9e3a9 |
93 | |
94 | =head2 Catalyst::Plugin::Prototype |
95 | |
35e6ab34 |
96 | L<Catalyst::Plugin::Prototype> is a plugin for the Prototype JavaScript |
97 | library. This Plugin allows you to easily implement AJAX functionality |
98 | without actually knowing Javascript. |
83b9e3a9 |
99 | |
c74caf1d |
100 | =head2 Catalyst::Plugin::RequireSSL |
101 | |
102 | Use L<Catalyst::Plugin::RequireSSL> if you would like to force visitors |
103 | to access certain pages using only SSL mode. An attempt to access the |
104 | page in non-SSL mode will receive a redirect into SSL mode. Useful for |
105 | shopping carts, user registration forms, and other sensitive data. |
106 | |
83b9e3a9 |
107 | =head2 Catalyst::Plugin::Session::FastMmap |
108 | |
35e6ab34 |
109 | L<Catalyst::Plugin::Session::FastMmap> is a session plugin for Catalyst |
110 | based on C<Cache::FastMMap>, which uses an mmap'ed file to act as a |
111 | shared memory interprocess cache. |
83b9e3a9 |
112 | |
113 | |
114 | =head2 Catalyst::Plugin::Static |
115 | |
c74caf1d |
116 | L<Catalyst::Plugin::Static> is a plugin to serve static files from |
117 | C<$c-E<gt>config-E<gt>{root}>. Intended chiefly for development |
118 | purposes. |
83b9e3a9 |
119 | |
120 | |
665dadd4 |
121 | =head2 Catalyst::Plugin::SubRequest |
122 | |
35e6ab34 |
123 | L<Catalyst::Plugin::SubRequest> is a plugin to allow subrequests to |
124 | actions to be made within Catalyst. Nice for portal software and such. |
665dadd4 |
125 | |
83b9e3a9 |
126 | =head2 Catalyst::Plugin::Textile |
127 | |
35e6ab34 |
128 | L<Catalyst::Plugin::Textile> is a persistent Textile processor for |
129 | Catalyst that uses C<Text::Textile>, a Perl-based implementation of Dean |
130 | Allen's Textile syntax. Textile is shorthand for doing common formatting |
131 | tasks (see L<http://textism.com>). |
83b9e3a9 |
132 | |
c42f5bbf |
133 | =head2 Catalyst::Plugin::Unicode |
134 | |
135 | L<Catalyst::Plugin::Unicode> provides a Unicode-aware Catalyst. On |
136 | request, it decodes all params from UTF-8 octets into a sequence of |
137 | logical characters. On response, it encodes the body into UTF-8 octets. |
83b9e3a9 |
138 | |
139 | =head2 Catalyst::Plugin::XMLRPC |
140 | |
35e6ab34 |
141 | L<Catalyst::Plugin::XMLRPC> plugin allows your Controller class to |
142 | dispatch XMLRPC methods from its own class. |
83b9e3a9 |
143 | |
144 | |
145 | =head1 COMPONENT MODULES |
146 | |
147 | =head2 Catalyst::Model::CDBI |
148 | |
35e6ab34 |
149 | L<Catalyst::Model::CDBI> is the C<Class::DBI> (CDBI) module class. It |
4911f47a |
150 | is built on top of C<Class::DBI::Loader>, which automates the |
151 | definition of C<Class::DBI> sub-classes by scanning the underlying |
152 | table schemas, setting up columns and primary keys. |
83b9e3a9 |
153 | |
386777dc |
154 | =head2 Catalyst::Model::CDBI::Plain |
155 | |
156 | L<Catalyst::Model::CDBI::Plain> is a neutral interface to the |
157 | C<Class::DBI> module, which does not attempt to automate table |
158 | setup. It allows the user to manually set up C<Class::DBI> |
159 | classes, either by doing so within the Catalyst model classes |
160 | themselves, or by inheriting from existing C<Class::DBI> |
161 | classes. |
162 | |
83b9e3a9 |
163 | =head2 Catalyst::Model::CDBI::CRUD |
164 | |
35e6ab34 |
165 | L<Catalyst::Model::CDBI::CRUD> is a subclass of |
c42f5bbf |
166 | C<Catalyst::Model::CDBI> with additional CRUD (create, retrieve, |
abea2aaa |
167 | update, delete) methods. |
83b9e3a9 |
168 | |
c42f5bbf |
169 | =head2 Catalyst::Model::Plucene |
170 | L<Catalyst::Model::Plucene> is the model class for the Plucene |
171 | search engine. |
83b9e3a9 |
172 | |
c42f5bbf |
173 | =head2 Catalyst::View::HTML::Template |
83b9e3a9 |
174 | |
c42f5bbf |
175 | L<Catalyst::View::HTML::Template> is a View component for |
176 | displaying your stash with L<HTML::Template>. |
177 | |
178 | =head2 Catalyst::View::PSP |
179 | |
180 | L<Catalyst::View::PSP> is a View component for displaying your |
181 | stash using PSP, a Perl extension implementing a JSP-like |
182 | templating system; see L<Text::PSP>. |
183 | |
184 | =head2 Catalyst::View::Petal |
185 | L<Catalyst::View::Petal> is a View component for displaying |
186 | your stash using Petal, the Perl Template Attribute Language, |
187 | an XML-based templating system; see L<Petal>. |
83b9e3a9 |
188 | |
abea2aaa |
189 | =head2 Catalyst::View::Mason |
190 | |
c42f5bbf |
191 | L<Catalyst::View::Mason> is a View component for displaying your stash |
192 | with L<HTML::Mason>. |
193 | |
194 | =head2 Catalyst::View::TT |
195 | |
196 | L<Catalyst::View::TT> is a Template Toolkit view. See |
197 | L<Template::Manual>. |
83b9e3a9 |
198 | |
199 | =head1 AUTHOR |
200 | |
201 | Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt> |
4911f47a |
202 | Marcus Ramberg E<lt>mramberg@cpan.orgE<gt> |
c42f5bbf |
203 | Jesse Sheidlower E<lt>jester@panix.comE<gt> |
83b9e3a9 |
204 | |
205 | =head1 COPYRIGHT |
206 | |
207 | This program is free software, you can redistribute it and/or modify it under |
208 | the same terms as Perl itself. |