3 Catalyst::Manual::Plugins - Catalyst Plugins (and Components)
7 This section lists the some of the plugins and components that are
8 available to extend the runtime functionality of Catalyst. Most plugins
9 are not distributed with Catalyst but should be available from CPAN.
10 They typically require additional modules from CPAN.
12 This list may well be outdated by the time you read this and some
13 plugins may be deprecated or now part of core L<Catalyst>. Be sure to
14 check the Catalyst::Plugin namespace for additional plugins and consult
15 the mailing list ( L<http://dev.catalyst.perl.org/wiki/Support> ) for
16 advice on the current status or preferred use of your chosen
21 =head2 L<Catalyst::Plugin::Account::AutoDiscovery>
23 Provides Account Auto-Discovery for Catalyst.
25 =head2 L<Catalyst::Plugin::Acme::Scramble>
27 Implements a potent meme about how easily we can read scrambled text if
28 the first and last letters remain constant. Operates on text/plain and
29 text/html served by your Catalyst application.
31 =head2 L<Catalyst::Plugin::Alarm>
33 =head2 L<Catalyst::Plugin::AtomPP>
35 Allows you to dispatch AtomPP methods.
37 =head2 L<Catalyst::Plugin::AtomServer>
39 A plugin that implements the necessary bits to make it easy to build an
40 Atom API server for any Catalyst-based application.
42 =head2 L<Catalyst::Plugin::Authentication>
44 An infrastructure plugin for the Catalyst authentication framework. Now the
45 recommended way to do any form of Authentication.
47 =head2 L<Catalyst::Plugin::Authentication::Credential::Atom>
49 L<Catalyst::Plugin::Authentication::Credential::Atom> is a plugin which
50 implements WSSE and Basic authentication for Catalyst applications using
51 L<Catalyst::Plugin::AtomServer>
53 =head2 L<Catalyst::Plugin::Authentication::Credential::CHAP>
55 =head2 L<Catalyst::Plugin::Authentication::Credential::Flickr>
57 Provides authentication via Flickr, using its API.
59 =head2 L<Catalyst::Plugin::Authentication::Credential::Hatena>
61 =head2 L<Catalyst::Plugin::Authentication::Credential::HTTP>
63 Implements HTTP Basic authentication for Catalyst.
65 =head2 L<Catalyst::Plugin::Authentication::Credential::JugemKey>
67 =head2 L<Catalyst::Plugin::Authentication::Credential::PAM>
69 =head2 L<Catalyst::Plugin::Authentication::Credential::Password>
71 Takes a username (or userid) and a password, and tries various methods of
72 comparing a password based on what the chosen store's user objects support.
73 Part of the Authentication Framework L<Catalyst::Plugin::Authentication>.
75 =head2 L<Catalyst::Plugin::Authentication::Credential::TypeKey>
77 Integrates L<Authen::TypeKey> with L<Catalyst::Plugin::Authentication>.
79 =head2 L<Catalyst::Plugin::Authentication::OpenID>
81 L<Catalyst::Plugin::Authentication::OpenID> is a plugin that implements
82 support for OpenID authentication. For more information on OpenID, take
83 a look at L<http://www.openid.net/>.
85 =head2 L<Catalyst::Plugin::Authentication::Store>
87 The core authentication store documentation.
89 =head2 L<Catalyst::Plugin::Authentication::Store::DBIC>
91 Does authentication and authorization against a L<DBIx::Class> or
94 =head2 L<Catalyst::Plugin::Authentication::Store::Htpasswd>
96 Uses L<Authen::Htpasswd> to let your application use C<.htpasswd> files for its
97 authentication storage.
99 =head2 L<Catalyst::Plugin::Authentication::Store::HTTP>
101 =head2 L<Catalyst::Plugin::Authentication::Store::LDAP>
103 Authenticates users using an LDAP server.
105 =head2 L<Catalyst::Plugin::Authentication::Store::Minimal>
107 Lets you create a very quick and dirty user database in your application's
108 config hash. Great for getting up and running quickly.
110 =head2 L<Catalyst::Plugin::Authentication::User::Hash>
112 An easy authentication user object based on hashes.
113 See L<Catalyst::Plugin::Authentication::Store::Minimal> for more info.
115 =head2 L<Catalyst::Plugin::Authorization::ACL>
117 This module provides Access Control List style path protection, with arbitrary
118 rules for L<Catalyst> applications. It operates only on the Catalyst private
119 namespace, at least at the moment.
121 =head2 L<Catalyst::Plugin::Authorization::Roles>
123 L<Catalyst::Plugin::Authorization::Roles> provides role based authorization
124 for Catalyst based on L<Catalyst::Plugin::Authentication>.
126 =head2 L<Catalyst::Plugin::AutoSession>
128 =head2 L<Catalyst::Plugin::Browser>
130 Extends L<Catalyst::Request> by adding the capability of browser
131 detection. It returns an instance of L<HTTP::BrowserDetect>, which lets
132 you get information from the client's user agent.
134 =head2 Catalyst::Plugin::Cache::FastMmap, FileCache, BerkeleyDB, and Memcached
136 L<Catalyst::Plugin::Cache::FastMmap>,
137 L<Catalyst::Plugin::Cache::FileCache>,
138 L<Catalyst::Plugin::Cache::BerkeleyDB>, and
139 L<Catalyst::Plugin::Cache::Memcached> all provide a cache method
140 enabling easy access to a shared cache.
142 =head2 L<Catalyst::Plugin::Captcha>
144 =head2 L<Catalyst::Plugin::CGI::Untaint>
146 =head2 L<Catalyst::Plugin::Charsets::Japanese>
148 =head2 L<Catalyst::Plugin::Compress::Bzip2>
150 =head2 L<Catalyst::Plugin::Compress::Deflate>
152 =head2 L<Catalyst::Plugin::Compress::Gzip>
154 =head2 L<Catalyst::Plugin::Compress::Zlib>
156 =head2 L<Catalyst::Plugin::ConfigLoader>
158 Provides a standard method for loading config files. Support
159 exists for various formats. See
160 L<Catalyst::Plugin::ConfigLoader::INI>,
161 L<Catalyst::Plugin::ConfigLoader::JSON>,
162 L<Catalyst::Plugin::ConfigLoader::Perl>,
163 L<Catalyst::Plugin::ConfigLoader::XML>, and
164 L<Catalyst::Plugin::ConfigLoader::YAML>
166 =head2 L<Catalyst::Plugin::ConfigurablePathTo>
168 =head2 L<Catalyst::Plugin::Continuation>
170 =head2 L<Catalyst::Plugin::DateTime>
172 =head2 L<Catalyst::Plugin::DefaultEnd>
174 Creates a sane, standard end method for your application.
176 =head2 L<Catalyst::Plugin::Devel::InPageLogs>
178 =head2 L<Catalyst::Plugin::Devel::InPageLogs::Log>
180 =head2 L<Catalyst::Plugin::Dojo>
182 =head2 L<Catalyst::Plugin::Dumper>
184 =head2 L<Catalyst::Plugin::Email>
186 Sends email with L<Email::Send> and L<Email::MIME::Creator>.
188 =head2 L<Catalyst::Plugin::Email::Japanese>
190 =head2 L<Catalyst::Plugin::Email::Page>
192 =head2 L<Catalyst::Plugin::EmailValid>
194 =head2 L<Catalyst::Plugin::FillInForm>
196 A plugin based on C<HTML::FillInForm>, which describes itself as a module
197 to automatically insert data from a previous HTML form into the HTML input,
198 textarea, radio buttons, checkboxes, and select tags. C<HTML::FillInForm>
199 is a subclass of C<HTML::Parser> and uses it to parse the HTML and insert
200 the values into the form tags.
202 =head2 L<Catalyst::Plugin::Flavour>
204 =head2 L<Catalyst::Plugin::FormValidator>
206 A form validator plugin that uses L<Data::FormValidator> to validate and
207 set up form data from your request parameters. It's a quite thin wrapper
208 around that module, so most of the relevant information can be found there.
210 =head2 L<Catalyst::Plugin::FormValidator::Simple>
212 =head2 L<Catalyst::Plugin::Geography>
214 Allows you to retrieve various kinds of geographical information. You can
215 retrieve the country or code from the current user, from a given IP
216 address, or from a given hostname.
218 =head2 L<Catalyst::Plugin::Geography::Implementation>
220 =head2 L<Catalyst::Plugin::HashedCookies>
222 =head2 L<Catalyst::Plugin::HTML::Scrubber>
224 =head2 L<Catalyst::Plugin::HTML::Widget>
226 =head2 L<Catalyst::Plugin::I18N>
228 An internationalization plugin for Catalyst. Supports C<mo>/C<po> files
229 and Maketext classes under your application's I18N namespace.
231 =head2 L<Catalyst::Plugin::JSONRPC>
233 =head2 L<Catalyst::Plugin::Markdown>
235 =head2 L<Catalyst::Plugin::Message>
237 =head2 L<Catalyst::Plugin::MobileAgent>
239 =head2 L<Catalyst::Plugin::Observe>
241 Provides the ability to register AOP-like callbacks to specific Engine
242 events. Subclasses L<Class::Publisher>.
244 =head2 L<Catalyst::Plugin::OrderedParams>
246 Adjusts the way that parameters operate, causing them to appear in the same
247 order they were submitted by the browser. This can be useful for creating
248 things such as email forms.
250 =head2 L<Catalyst::Plugin::PageCache>
252 Helps improve the performance of slow or frequently accessed pages by
253 caching the entire output of your page. Subsequent requests to the page
254 will receive the page very quickly from cache.
256 =head2 L<Catalyst::Plugin::Params::Nested>
258 =head2 L<Catalyst::Plugin::Params::Nested::Expander>
260 =head2 L<Catalyst::Plugin::Pluggable>
262 A plugin for pluggable Catalyst applications.
264 =head2 L<Catalyst::Plugin::Prototype>
266 A plugin for the Prototype JavaScript library. This Plugin allows you to
267 easily implement AJAX functionality without actually knowing Javascript.
269 =head2 L<Catalyst::Plugin::Redirect>
271 =head2 L<Catalyst::Plugin::RequestToken>
273 =head2 L<Catalyst::Plugin::RequireSSL>
275 Use this if you would like to force visitors to access certain pages using
276 only SSL mode. An attempt to access the page in non-SSL mode will receive a
277 redirect into SSL mode. Useful for login pages, shopping carts, user
278 registration forms, and other sensitive data.
280 =head2 L<Catalyst::Plugin::Scheduler>
282 =head2 L<Catalyst::Plugin::Session>
284 The L<Catalyst::Plugin::Session> series of modules provide an easy way to
285 include session handling in an application. You can choose from several
286 different backend storage methods and combine that with your choice of
287 client-side storage methods.
289 =head2 L<Catalyst::Plugin::Session::PerUser>
291 =head2 L<Catalyst::Plugin::Session::State>
293 =head2 L<Catalyst::Plugin::Session::State::Cookie>
295 =head2 L<Catalyst::Plugin::Session::State::URI>
297 =head2 L<Catalyst::Plugin::Session::Store>
299 =head2 L<Catalyst::Plugin::Session::Store::CDBI>
301 =head2 L<Catalyst::Plugin::Session::Store::DBI>
303 =head2 L<Catalyst::Plugin::Session::Store::DBIC>
305 =head2 L<Catalyst::Plugin::Session::Store::Dummy>
307 =head2 L<Catalyst::Plugin::Session::Store::FastMmap>
309 =head2 L<Catalyst::Plugin::Session::Store::File>
311 =head2 L<Catalyst::Plugin::Session::Store::Memcached>
313 =head2 L<Catalyst::Plugin::Session::Test::Store>
315 =head2 L<Catalyst::Plugin::Singleton>
317 =head2 L<Catalyst::Plugin::Snippets>
319 =head2 L<Catalyst::Plugin::SRU>
321 Allows your controller class to dispatch SRU actions (C<explain>, C<scan>,
322 and C<searchRetrieve>) from its own class.
324 =head2 L<Catalyst::Plugin::StackTrace>
326 =head2 L<Catalyst::Plugin::Static>
328 L<Catalyst::Plugin::Static> is a plugin to serve static files from
329 C<< $c->config->{root} >>. Intended chiefly for development
332 =head2 L<Catalyst::Plugin::Static::Simple>
334 Serves static files in your application without requiring a single line of
335 code. This plugin is now included in the core Catalyst distribution.
337 =head2 L<Catalyst::Plugin::SubRequest>
339 A plugin to allow subrequests to actions to be made within Catalyst. Nice
340 for portal software and such.
342 =head2 L<Catalyst::Plugin::SuperForm>
344 An interface to the L<HTML::SuperForm> module, enabling easy HTML form
347 =head2 L<Catalyst::Plugin::Textile>
349 A persistent Textile processor for Catalyst that uses C<Text::Textile>, a
350 Perl-based implementation of Dean Allen's Textile syntax. Textile is
351 shorthand for doing common formatting tasks (see L<http://textism.com>).
353 =head2 L<Catalyst::Plugin::Unicode>
355 Provides a Unicode-aware Catalyst. On request, it decodes all params from
356 UTF-8 octets into a sequence of logical characters. On response, it encodes
357 the body into UTF-8 octets.
359 =head2 L<Catalyst::Plugin::Unicode::Encoding>
361 =head2 L<Catalyst::Plugin::Upload::Basename>
363 =head2 L<Catalyst::Plugin::Upload::MD5>
365 =head2 L<Catalyst::Plugin::Upload::MIME>
367 =head2 L<Catalyst::Plugin::UploadProgress>
369 =head2 L<Catalyst::Plugin::XMLRPC>
371 Allows your Controller class to dispatch XMLRPC methods from its own class.
375 =head2 L<Catalyst::Controller::BindLex>
377 Lets you mark lexical variables with a C<Stashed> attribute, automatically
378 passing them to the stash.
382 =head2 L<Catalyst::Model::CDBI>
384 The C<Class::DBI> (CDBI) model class. It is built on top of
385 C<Class::DBI::Loader>, which automates the definition of C<Class::DBI>
386 sub-classes by scanning the underlying table schemas, setting up columns
389 =head2 L<Catalyst::Model::CDBI::Plain>
391 A neutral interface to the C<Class::DBI> module which does not attempt
392 to automate table setup. It allows the user to manually set up
393 C<Class::DBI> classes, either by doing so within the Catalyst model
394 classes themselves, or by inheriting from existing C<Class::DBI>
397 =head2 L<Catalyst::Model::DBIC::Schema>
399 A L<DBIx::Class> model class that can use either an explicit
400 L<DBIx::Class::Schema> or one automatically loaded from your database
401 via L<DBIx::Class::Schema::Loader>.
403 =head2 L<Catalyst::Model::EVDB>
405 =head2 L<Catalyst::Model::File>
407 =head2 L<Catalyst::Model::Gedcom>
409 =head2 L<Catalyst::Model::LDAP>
411 =head2 L<Catalyst::Model::NetBlogger>
413 =head2 L<Catalyst::Model::Plucene>
415 A model class for the Plucene search engine.
417 =head2 L<Catalyst::Model::Proxy>
419 =head2 L<Catalyst::Model::SVN>
421 =head2 L<Catalyst::Model::Xapian>
423 A model class for the Xapian search engine.
427 =head2 L<Catalyst::View::Atom::XML>
429 =head2 L<Catalyst::View::Chart::Strip>
431 =head2 L<Catalyst::View::CSS::Squish>
433 =head2 L<Catalyst::View::Embperl>
435 =head2 L<Catalyst::View::GD::Barcode>
437 =head2 L<Catalyst::View::GraphViz>
439 =head2 L<Catalyst::View::HTML::Template>
441 A view component for rendering pages with L<HTML::Template>.
443 =head2 L<Catalyst::View::Jemplate>
445 =head2 L<Catalyst::View::JSON>
447 =head2 L<Catalyst::View::Mason>
449 A view component for rendering pages with L<HTML::Mason>.
451 =head2 L<Catalyst::View::MicroMason>
453 =head2 L<Catalyst::View::PHP>
455 =head2 L<Catalyst::View::PSP>
457 A view component for rendering pages using PSP, a Perl extension
458 implementing a JSP-like templating system. See L<Text::PSP>.
460 =head2 L<Catalyst::View::Petal>
462 A view component for rendering pages using Petal, the Perl Template
463 Attribute Language, an XML-based templating system. See L<Petal>.
465 =head2 L<Catalyst::View::TT>
467 A view component for rendering pages with Template Toolkit. See
470 =head2 L<Catalyst::View::XSLT>
472 =head2 L<Catalyst::View::vCard>
474 =head1 OBSOLETE MODULES
476 =head2 L<Catalyst::Model::DBIC>
478 Replaced by L<Catalyst::Model::DBIC::Schema>.
480 =head2 L<Catalyst::Plugin::Authentication::Basic::Remote>
482 Replaced by L<Catalyst::Plugin::Authentication::Credential::HTTP>.
484 =head2 L<Catalyst::Plugin::Authentication::CDBI>
486 Replaced by L<Catalyst::Plugin::Authentication::Store::DBIC>.
488 =head2 L<Catalyst::Plugin::Authentication::CDBI::Basic>
490 Replaced by L<Catalyst::Plugin::Authentication::Credential::HTTP>.
492 =head2 L<Catalyst::Plugin::Authentication::LDAP>
494 Replaced by L<Catalyst::Plugin::Authentication::Store::LDAP>.
496 =head2 L<Catalyst::Plugin::Authentication::Simple>
498 Replaced by L<Catalyst::Plugin::Authentication>.
500 =head2 L<Catalyst::Plugin::Authorization::CDBI::GroupToken>
502 =head2 L<Catalyst::Plugin::CDBI::Transaction>
504 =head2 Catalyst::Plugin::Config::*
506 The L<Catalyst::Plugin::Config::JSON> and
507 L<Catalyst::Plugin::Config::YAML> modules have been replaced by their
508 corresponding L<Catalyst::Plugin::ConfigLoader> modules.
510 =head2 L<Catalyst::Plugin::DefaultEnd>
512 Replaced by L<Catalyst::Action::RenderView>
514 =head2 L<Catalyst::Plugin::SanitizeUrl>
516 =head2 L<Catalyst::Plugin::SanitizeUrl::PrepAction>
518 =head2 Catalyst::Plugin::Session::*
520 The L<Catalyst::Plugin::Session::CGISession>,
521 L<Catalyst::Plugin::Session::FastMmap>,
522 L<Catalyst::Plugin::Session::Flex>, and
523 L<Catalyst::Plugin::Session::Manager>
524 modules have been replaced by the <Catalyst::Plugin::Session> framework.
528 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
530 Gavin Henry E<lt>ghenry@suretecsystems.comE<gt>
532 Jesse Sheidlower E<lt>jester@panix.comE<gt>
534 Marcus Ramberg E<lt>mramberg@cpan.orgE<gt>
536 David Kamholz E<lt>dkamholz@cpan.orgE<gt>
540 This program is free software, you can redistribute it and/or modify it under
541 the same terms as Perl itself.