3 Catalyst::Manual::Component - Reuseable components for Catalyst applications.
7 This section lists the some of the components (and plugins) that are
8 available to extend the runtime functionality of Catalyst. Most components
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:: and CatalystX:: namespaces for additional components 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 Note that newer versions of the authentication plugin allow multiple
48 C<realms>, so that you can authenticate users in different ways in different
49 parts of your application.
51 This, however, has involved deprecated all classes in the
52 C<Catalyst::Plugin::Authentication::Credential::XXX> and
53 C<Catalyst::Plugin::Authentication::Store::XXX> namespaces.
55 These plugins are still useable, however they have mostly been
56 replaced with new modules in the new namespace which will work together.
58 =head3 Available Credential modules:
60 =head4 L<Catalyst::Authentication::Credential::AuthTkt>
62 Allows you to use the L<Apache::AuthTkt> module with Catalyst.
64 =head4 L<Catalyst::Authentication::Credential::FBConnect>
66 Allows you to authenticate facebook users using the FBConnect API.
68 =head4 L<Catalyst::Authentication::Credential::Flickr>
70 Provides authentication via Flickr, using its API.
72 =head4 L<Catalyst::Authentication::Credential::HTTP>
74 Allows you to authenticate users using HTTP Basic or Digest authentication.
76 =head4 L<Catalyst::Authentication::Credential::HTTP::Proxy>
78 Allows you to authenticate users against a remote web server
79 offering HTTP authentication.
81 =head4 L<Catalyst::Authentication::Credential::Kerberos>
83 Allows you to authenticate your users against a Kerberos server.
85 =head4 L<Catalyst::Authentication::Credential::OAuth>
87 Allows you to authenticate users using their login on other websites supporting
90 =head4 L<Catalyst::Authentication::Credential::OpenID>
92 Allows you to authenticate users using their login on other websites supporting
95 =head4 L<Catalyst::Authentication::Credential::Password>
97 Takes a username (or userid) and a password, and tries various methods of
98 comparing a password based on what the chosen store's user objects support.
99 Part of the Authentication Framework L<Catalyst::Plugin::Authentication>.
101 =head4 L<Catalyst::Authentication::Credential::RPX>
103 Allows you to autheticate users using the RPX protocol.
105 =head4 L<Catalyst::Authentication::Credential::Remote>
107 Allows you to authenticate users in Catalyst which have already been
108 authenticated by your web server - this is useful for authenticating
109 users with SSL Client certificates, and using NTLM or any other
110 authentication protocol natively supported by your web server.
112 =head4 L<Catalyst::Authentication::Credential::Testing>
114 Allows you to set the same password for all users, which is useful
115 when you want to test logging in as multiple users / types of user,
116 without having to mock things, or set all users passwords in your
119 =head4 L<Catalyst::Authentication::Credential::Authen::Simple>
121 Allows any of the L<Authen::Simple> family of modules to be used
122 to authenticate users in Catalyst.
124 =head3 LAvailable Store modules:
126 =head4 L<Catalyst::Authentication::Store::DBIx::Class>
128 Does authentication and authorization against a L<DBIx::Class> model.
130 =head4 L<Catalyst::Authentication::Store::Htpasswd>
132 Uses L<Authen::Htpasswd> to let your application use C<.htpasswd> files for its
133 authentication storage.
135 =head4 L<Catalyst::Authentication::Store::AuthTkt>
137 This module implements the Catalyst::Authentication API for L<Apache::AuthTkt>.
139 =head4 L<Catalyst::Authentication::Store::DBI>
141 Allows you to use a plain L<DBI> database connection to identify users.
143 =head4 L<Catalyst::Authentication::Store::Htpasswd>
145 Allows you to use an apache htpassed type file to authenticate users from.
147 =head4 L<Catalyst::Authentication::Store::KiokuDB>
149 Authenticate users stored as objects in the L<KiokuDB> object graph storage
152 =head4 L<Catalyst::Authentication::Store::LDAP>
154 Authenticates users using an LDAP server.
156 =head4 L<Catalyst::Authentication::Store::Minimal>
158 Lets you create a very quick and dirty user database in your application's
159 config hash. Great for getting up and running quickly.
161 =head4 L<Catalyst::Authentication::Store::Null>
163 The Null store is a transparent store where any supplied user data is accepted.
164 This is mainly useful for remotely authenticating credentials (e.g. OpenID) which
165 may not be tied to any local storage.
167 =head4 L<Catalyst::Authentication::Store::RDBO>
169 Allows access to authentication information stored in a database via a L<Rose::DB::Object> class.
171 =head4 L<Catalyst::Authentication::Store::Tangram>
173 Allows access to authentication information stored in a database via a L<Tangram> class.
175 =head4 L<Catalyst::Authentication::Store::DBIx::Class>
177 Allows access to authentication information stored in a database via a L<DBIx::Class> class.
179 =head4 L<Catalyst::Authentication::Store::Jifty::DBI>
181 Allows access to authentication information stored in a database via a L<Jifty::DBI> class.
183 =head4 L<Catalyst::Authentication::User::Hash>
185 An easy authentication user object based on hashes.
186 See L<Catalyst::Authentication::Store::Minimal> for more info.
188 =head2 L<Catalyst::Plugin::Authorization::ACL>
190 This module provides Access Control List style path protection, with arbitrary
191 rules for L<Catalyst> applications. It operates only on the Catalyst private
192 namespace, at least at the moment.
194 =head2 L<Catalyst::Plugin::Authorization::Roles>
196 L<Catalyst::Plugin::Authorization::Roles> provides role based authorization
197 for Catalyst based on L<Catalyst::Plugin::Authentication>.
199 =head2 L<Catalyst::Plugin::AutoSession>
201 =head2 L<Catalyst::Plugin::Browser>
203 Extends L<Catalyst::Request> by adding the capability of browser
204 detection. It returns an instance of L<HTTP::BrowserDetect>, which lets
205 you get information from the client's user agent.
207 =head2 L<Catalyst::Plugin::Cache>
209 Provides a cache method enabling easy access to a shared cache implementing
210 the C<< Cache:: >> APO, such as:
226 =head2 L<Catalyst::Plugin::CGI::Untaint>
228 =head2 L<Catalyst::Plugin::Charsets::Japanese>
230 =head2 L<Catalyst::Plugin::Compress::Bzip2>
232 =head2 L<Catalyst::Plugin::Compress::Deflate>
234 =head2 L<Catalyst::Plugin::Compress::Gzip>
236 =head2 L<Catalyst::Plugin::Compress::Zlib>
238 =head2 L<Catalyst::Plugin::ConfigLoader>
240 Provides a standard method for loading config files. Support
241 exists for various formats. See
242 L<Catalyst::Plugin::ConfigLoader::General>
243 L<Catalyst::Plugin::ConfigLoader::INI>,
244 L<Catalyst::Plugin::ConfigLoader::JSON>,
245 L<Catalyst::Plugin::ConfigLoader::Perl>,
246 L<Catalyst::Plugin::ConfigLoader::XML>, and
247 L<Catalyst::Plugin::ConfigLoader::YAML>
249 =head2 L<Catalyst::Plugin::ConfigurablePathTo>
251 =head2 L<Catalyst::Plugin::Devel::InPageLogs>
253 =head2 L<Catalyst::Plugin::Devel::InPageLogs::Log>
255 =head2 L<Catalyst::Plugin::Dojo>
257 =head2 L<Catalyst::Plugin::Dumper>
259 =head2 L<Catalyst::Plugin::Email>
261 Sends email with L<Email::Send> and L<Email::MIME::Creator>.
263 =head2 L<Catalyst::Plugin::Email::Japanese>
265 =head2 L<Catalyst::Plugin::Email::Page>
267 =head2 L<Catalyst::Plugin::EmailValid>
269 =head2 L<Catalyst::Plugin::FillInForm>
271 A plugin based on C<HTML::FillInForm>, which describes itself as a module
272 to automatically insert data from a previous HTML form into the HTML input,
273 textarea, radio buttons, checkboxes, and select tags. C<HTML::FillInForm>
274 is a subclass of C<HTML::Parser> and uses it to parse the HTML and insert
275 the values into the form tags.
277 =head2 L<Catalyst::Plugin::Flavour>
279 =head2 L<Catalyst::Plugin::Geography>
281 Allows you to retrieve various kinds of geographical information. You can
282 retrieve the country or code from the current user, from a given IP
283 address, or from a given hostname.
285 =head2 L<Catalyst::Plugin::Geography::Implementation>
287 =head2 L<Catalyst::Plugin::HashedCookies>
289 =head2 L<Catalyst::Plugin::HTML::Scrubber>
291 =head2 L<Catalyst::Plugin::I18N>
293 An internationalization plugin for Catalyst. Supports C<mo>/C<po> files
294 and Maketext classes under your application's I18N namespace.
296 =head2 L<Catalyst::Plugin::JSONRPC>
298 =head2 L<Catalyst::Plugin::Message>
300 =head2 L<Catalyst::Plugin::MobileAgent>
302 =head2 L<Catalyst::Plugin::Observe>
304 Provides the ability to register AOP-like callbacks to specific Engine
305 events. Subclasses L<Class::Publisher>.
307 =head2 L<Catalyst::Plugin::OrderedParams>
309 Adjusts the way that parameters operate, causing them to appear in the same
310 order they were submitted by the browser. This can be useful for creating
311 things such as email forms.
313 =head2 L<Catalyst::Plugin::PageCache>
315 Helps improve the performance of slow or frequently accessed pages by
316 caching the entire output of your page. Subsequent requests to the page
317 will receive the page very quickly from cache.
319 =head2 L<Catalyst::Plugin::Params::Nested>
321 =head2 L<Catalyst::Plugin::Params::Nested::Expander>
323 =head2 L<Catalyst::Plugin::Pluggable>
325 A plugin for pluggable Catalyst applications.
327 =head2 L<Catalyst::Plugin::Prototype>
329 A plugin for the Prototype JavaScript library. This Plugin allows you to
330 easily implement AJAX functionality without actually knowing Javascript.
332 =head2 L<Catalyst::Plugin::Redirect>
334 =head2 L<Catalyst::Plugin::RequestToken>
336 =head2 L<Catalyst::Plugin::RequireSSL>
338 Use this if you would like to force visitors to access certain pages using
339 only SSL mode. An attempt to access the page in non-SSL mode will receive a
340 redirect into SSL mode. Useful for login pages, shopping carts, user
341 registration forms, and other sensitive data.
343 =head2 L<Catalyst::Plugin::Scheduler>
345 =head2 L<Catalyst::Plugin::Session>
347 The L<Catalyst::Plugin::Session> series of modules provide an easy way to
348 include session handling in an application. You can choose from several
349 different backend storage methods and combine that with your choice of
350 client-side storage methods.
352 =head2 L<Catalyst::Plugin::Session::PerUser>
354 =head2 L<Catalyst::Plugin::Session::State>
356 =head2 L<Catalyst::Plugin::Session::State::Cookie>
358 =head2 L<Catalyst::Plugin::Session::State::URI>
360 =head2 L<Catalyst::Plugin::Session::Store>
362 =head2 L<Catalyst::Plugin::Session::Store::CDBI>
364 =head2 L<Catalyst::Plugin::Session::Store::DBI>
366 =head2 L<Catalyst::Plugin::Session::Store::DBIC>
368 =head2 L<Catalyst::Plugin::Session::Store::Dummy>
370 =head2 L<Catalyst::Plugin::Session::Store::FastMmap>
372 =head2 L<Catalyst::Plugin::Session::Store::File>
374 =head2 L<Catalyst::Plugin::Session::Store::Memcached>
376 =head2 L<Catalyst::Plugin::Session::Test::Store>
378 =head2 L<Catalyst::Plugin::Singleton>
380 =head2 L<Catalyst::Plugin::Snippets>
382 =head2 L<Catalyst::Plugin::SRU>
384 Allows your controller class to dispatch SRU actions (C<explain>, C<scan>,
385 and C<searchRetrieve>) from its own class.
387 =head2 L<Catalyst::Plugin::StackTrace>
389 =head2 L<Catalyst::Plugin::Static>
391 L<Catalyst::Plugin::Static> is a plugin to serve static files from
392 C<< $c->config(root => 'foo') >>. Intended chiefly for development
395 =head2 L<Catalyst::Plugin::Static::Simple>
397 Serves static files in your application without requiring a single line of
400 =head2 L<Catalyst::Plugin::SubRequest>
402 A plugin to allow subrequests to actions to be made within Catalyst. Nice
403 for portal software and such.
405 =head2 L<Catalyst::Plugin::SuperForm>
407 An interface to the L<HTML::SuperForm> module, enabling easy HTML form
410 =head2 L<Catalyst::Plugin::Unicode>
412 Provides a Unicode-aware Catalyst. On request, it decodes all params from
413 UTF-8 octets into a sequence of logical characters. On response, it encodes
414 the body into UTF-8 octets.
416 =head2 L<Catalyst::Plugin::Unicode::Encoding>
418 =head2 L<Catalyst::Plugin::Upload::Basename>
420 =head2 L<Catalyst::Plugin::Upload::MD5>
422 =head2 L<Catalyst::Plugin::Upload::MIME>
424 =head2 L<Catalyst::Plugin::UploadProgress>
426 =head2 L<Catalyst::Plugin::XMLRPC>
428 Allows your Controller class to dispatch XMLRPC methods from its own class.
432 =head2 L<Catalyst::Controller::HTML::FormFu>
434 Catalyst integration for <HTML::FormFu>.
438 =head2 L<Catalyst::Model::CDBI>
440 The C<Class::DBI> (CDBI) model class. It is built on top of
441 C<Class::DBI::Loader>, which automates the definition of C<Class::DBI>
442 sub-classes by scanning the underlying table schemas, setting up columns
445 =head2 L<Catalyst::Model::CDBI::Plain>
447 A neutral interface to the C<Class::DBI> module which does not attempt
448 to automate table setup. It allows the user to manually set up
449 C<Class::DBI> classes, either by doing so within the Catalyst model
450 classes themselves, or by inheriting from existing C<Class::DBI>
453 =head2 L<Catalyst::Model::DBIC::Schema>
455 A L<DBIx::Class> model class that can use either an explicit
456 L<DBIx::Class::Schema> or one automatically loaded from your database
457 via L<DBIx::Class::Schema::Loader>.
459 =head2 L<Catalyst::Model::EVDB>
461 =head2 L<Catalyst::Model::File>
463 =head2 L<Catalyst::Model::Gedcom>
465 =head2 L<Catalyst::Model::LDAP>
467 =head2 L<Catalyst::Model::NetBlogger>
469 =head2 L<Catalyst::Model::Plucene>
471 A model class for the Plucene search engine.
473 =head2 L<Catalyst::Model::Proxy>
475 =head2 L<Catalyst::Model::SVN>
477 =head2 L<Catalyst::Model::Xapian>
479 A model class for the Xapian search engine.
483 =head2 L<Catalyst::View::Atom::XML>
485 =head2 L<Catalyst::View::Chart::Strip>
487 =head2 L<Catalyst::View::CSS::Squish>
489 =head2 L<Catalyst::View::Embperl>
491 =head2 L<Catalyst::View::GD::Barcode>
493 =head2 L<Catalyst::View::GraphViz>
495 =head2 L<Catalyst::View::HTML::Template>
497 A view component for rendering pages with L<HTML::Template>.
499 =head2 L<Catalyst::View::Jemplate>
501 =head2 L<Catalyst::View::JSON>
503 =head2 L<Catalyst::View::Mason>
505 A view component for rendering pages with L<HTML::Mason>.
507 =head2 L<Catalyst::View::MicroMason>
509 =head2 L<Catalyst::View::PHP>
511 =head2 L<Catalyst::View::PSP>
513 A view component for rendering pages using PSP, a Perl extension
514 implementing a JSP-like templating system. See L<Text::PSP>.
516 =head2 L<Catalyst::View::Petal>
518 A view component for rendering pages using Petal, the Perl Template
519 Attribute Language, an XML-based templating system. See L<Petal>.
521 =head2 L<Catalyst::View::TT>
523 A view component for rendering pages with Template Toolkit. See
526 =head2 L<Catalyst::View::XSLT>
528 =head2 L<Catalyst::View::vCard>
532 =head2 L<Catalyst::Action::RenderView>
534 Creates a sane, standard end method for your application.
536 =head1 OBSOLETE MODULES
538 =head2 L<Catalyst::Controller::BindLex>
540 Lets you mark lexical variables with a C<Stashed> attribute, automatically
541 passing them to the stash. Discouraged by the author.
543 =head2 L<Catalyst::Model::DBIC>
545 Replaced by L<Catalyst::Model::DBIC::Schema>.
547 =head2 L<Catalyst::Plugin::Authentication::Basic::Remote>
549 Replaced by L<Catalyst::Plugin::Authentication::Credential::HTTP>.
551 =head2 L<Catalyst::Plugin::Authentication::CDBI>
553 Replaced by L<Catalyst::Plugin::Authentication::Store::DBIC>.
555 =head2 L<Catalyst::Plugin::Authentication::CDBI::Basic>
557 Replaced by L<Catalyst::Plugin::Authentication::Credential::HTTP>.
559 =head2 L<Catalyst::Plugin::Authentication::LDAP>
561 Replaced by L<Catalyst::Plugin::Authentication::Store::LDAP>.
563 =head2 L<Catalyst::Plugin::Authentication::Simple>
565 Replaced by L<Catalyst::Plugin::Authentication>.
567 =head2 L<Catalyst::Plugin::Authorization::CDBI::GroupToken>
569 =head2 L<Catalyst::Plugin::CDBI::Transaction>
571 =head2 Catalyst::Plugin::Config::*
573 The L<Catalyst::Plugin::Config::JSON> and
574 L<Catalyst::Plugin::Config::YAML> modules have been replaced by their
575 corresponding L<Catalyst::Plugin::ConfigLoader> modules.
577 =head2 L<Catalyst::Plugin::DefaultEnd>
579 Replaced by L<Catalyst::Action::RenderView>
581 =head2 L<Catalyst::Plugin::SanitizeUrl>
583 =head2 L<Catalyst::Plugin::SanitizeUrl::PrepAction>
585 =head2 Catalyst::Plugin::Session::*
587 The L<Catalyst::Plugin::Session::CGISession>,
588 L<Catalyst::Plugin::Session::FastMmap>,
589 L<Catalyst::Plugin::Session::Flex>, and
590 L<Catalyst::Plugin::Session::Manager>
591 modules have been replaced by the <Catalyst::Plugin::Session> framework.
595 Catalyst Contributors, see Catalyst.pm
599 This library is free software. You can redistribute it and/or modify it under
600 the same terms as Perl itself.