Catalyst::Manual::Components - Reuseable components for Catalyst applications
This section lists the some of the components (and plugins) that are available to extend the runtime functionality of Catalyst. Most components are not distributed with Catalyst but should be available from CPAN. They typically require additional modules from CPAN.
This list may well be outdated by the time you read this, and some plugins may be deprecated, or, conversely, may now part of core Catalyst. Be sure to check the Catalyst:: and CatalystX:: namespaces for additional components, and consult the mailing list ( http://dev.catalyst.perl.org/wiki/Support ) for advice on the current status or preferred use of your chosen plugin/framework.
Provides Account Auto-Discovery for Catalyst.
Implements a potent meme about how easily we can read scrambled text if the first and last letters remain constant. Operates on text/plain and text/html served by your Catalyst application.
Allows you to dispatch AtomPP methods.
A plugin that implements the necessary bits to make it easy to build an Atom API server for any Catalyst-based application.
An infrastructure plugin for the Catalyst authentication framework. Now the recommended way to do any form of Authentication.
Note that newer versions of the authentication plugin allow multiple
so that you can authenticate users in different ways in different parts of your application.
has involved deprecated all classes in the
These plugins are still usable, but they have mostly been replaced with new modules in the new namespace which will work together.
Allows you to use the Apache::AuthTkt module with Catalyst.
Allows you to authenticate Facebook users using the FBConnect API.
Provides authentication via Flickr, using its API.
Allows you to authenticate users using HTTP Basic or Digest authentication.
Allows you to authenticate users against a remote web server offering HTTP authentication.
Allows you to authenticate your users against a Kerberos server.
Allows you to authenticate users using their login on other websites supporting the OAuth protocol.
Allows you to authenticate users using their login on other websites supporting the OpenID protocol.
Takes a username (or userid) and a password, and tries various methods of comparing a password based on what the chosen store's user objects support. Part of the Authentication Framework Catalyst::Plugin::Authentication.
Allows you to authenticate users using the RPX protocol.
Allows you to authenticate users in Catalyst that have already been authenticated by your web server. This is useful for authenticating users with SSL Client certificates, and using NTLM or any other authentication protocol natively supported by your web server.
Allows you to set the same password for all users, which is useful when you want to test logging in as multiple users or multiple types of user, without having to mock things, or set all users' passwords in your test suite.
Allows any of the Authen::Simple family of modules to be used to authenticate users in Catalyst.
Does authentication and authorization against a DBIx::Class model.
Uses Authen::Htpasswd to let your application use
.htpasswd files for its authentication storage.
This module implements the Catalyst::Authentication API for Apache::AuthTkt.
Allows you to use a plain DBI database connection to identify users.
Allows you to use an Apache htpasswd type file to authenticate users.
Authenticate users stored as objects in the KiokuDB object graph storage engine system.
Authenticates users using an LDAP server.
Lets you create a very quick and dirty user database in your application's config hash. Great for getting up and running quickly.
The Null store is a transparent store where any supplied user data is accepted. This is mainly useful for remotely authenticating credentials (e.g. OpenID) which may not be tied to any local storage.
Allows access to authentication information stored in a database via a Rose::DB::Object class.
Allows access to authentication information stored in a database via a Tangram class.
Allows access to authentication information stored in a database via a DBIx::Class class.
Allows access to authentication information stored in a database via a Jifty::DBI class.
An easy authentication user object based on hashes. See Catalyst::Authentication::Store::Minimal for more info.
This module provides Access Control List style path protection, with arbitrary rules for Catalyst applications. It operates only on the Catalyst private namespace, at least at the moment.
Catalyst::Plugin::AutoSession enables specified request parameters to generate session variables.
Provides a cache method enabling easy access to a shared cache implementing the
Provides specific charset handlers for the Japanese charsets.
Provides a standard method for loading config files. Support exists for various formats. See Catalyst::Plugin::ConfigLoader::General Catalyst::Plugin::ConfigLoader::INI, Catalyst::Plugin::ConfigLoader::JSON, Catalyst::Plugin::ConfigLoader::Perl, Catalyst::Plugin::ConfigLoader::XML, and Catalyst::Plugin::ConfigLoader::YAML
A plugin based on
which describes itself as a module to automatically insert data from a previous HTML form into the HTML input,
and select tags.
HTML::FillInForm is a subclass of
HTML::Parser and uses it to parse the HTML and insert the values into the form tags.
Allows you to retrieve various kinds of geographical information. You can retrieve the country or code from the current user, from a given IP address, or from a given hostname.
An internationalization plugin for Catalyst.
po files and Maketext classes under your application's I18N namespace.
Provides the ability to register AOP-like callbacks to specific Engine events. Subclasses Class::Publisher.
Adjusts the way that parameters operate, causing them to appear in the same order they were submitted by the browser. This can be useful for creating things such as email forms.
Helps improve the performance of slow or frequently accessed pages by caching the entire output of your page. Subsequent requests to the page will receive the page very quickly from cache.
A plugin for pluggable Catalyst applications.
Allows for easy redirecting with the Catalyst app.
Use this if you would like to force visitors to access certain pages using only SSL mode. An attempt to access the page in non-SSL mode will receive a redirect into SSL mode. Useful for login pages, shopping carts, user registration forms, and other sensitive data.
The Catalyst::Plugin::Session series of modules provide an easy way to include session handling in an application. You can choose from several different backend storage methods and combine that with your choice of client-side storage methods.
Allows your controller class to dispatch SRU actions (
searchRetrieve) from its own class.
Catalyst::Plugin::Static is a plugin to serve static files from
$c->config(root => 'foo').
Intended chiefly for development purposes.
Serves static files in your application without requiring a single line of code.
A plugin to allow subrequests to actions to be made within Catalyst. Nice for portal software and such.
An interface to the HTML::SuperForm module, enabling easy HTML form creation.
Provides a Unicode-aware Catalyst. On request, it decodes all params from UTF-8 octets into a sequence of logical characters. On response, it encodes the body into UTF-8 octets.
Disrecommended plugin which tries to autodetect the uft8ness of the output and do the correct thing. This may work in some cases, but if it helps, you've already painted yourself into a corner - try to avoid!
Computes the MD5 message digest of uploaded files.
Allows your Controller class to dispatch XMLRPC methods from its own class.
Catalyst integration for <HTML::FormFu>.
Class::DBI (CDBI) model class.
It is built on top of
which automates the definition of
Class::DBI sub-classes by scanning the underlying table schemas,
setting up columns and primary keys.
A neutral interface to the
Class::DBI module which does not attempt to automate table setup.
It allows the user to manually set up
either by doing so within the Catalyst model classes themselves,
or by inheriting from existing
A model class for the Plucene search engine.
A model class for the Xapian search engine.
A view component for rendering pages with HTML::Template.
A view component for rendering pages with HTML::Mason.
A view component for rendering pages using PSP, a Perl extension implementing a JSP-like templating system. See Text::PSP.
A view component for rendering pages using Petal, the Perl Template Attribute Language, an XML-based templating system. See Petal.
A view component for rendering pages with Template Toolkit. See Template::Manual.
Creates a sane, standard end method for your application.
Lets you mark lexical variables with a
automatically passing them to the stash.
Discouraged by the author.
Replaced by Catalyst::Model::DBIC::Schema.
Replaced by Catalyst::Plugin::Authentication::Credential::HTTP.
Replaced by Catalyst::Plugin::Authentication::Store::DBIC.
Replaced by Catalyst::Plugin::Authentication::Credential::HTTP.
Replaced by Catalyst::Plugin::Authentication::Store::LDAP.
Replaced by Catalyst::Plugin::Authentication.
Replaced by Catalyst::Action::RenderView
The Catalyst::Plugin::Session::CGISession, Catalyst::Plugin::Session::FastMmap, Catalyst::Plugin::Session::Flex, and Catalyst::Plugin::Session::Manager modules have been replaced by the <Catalyst::Plugin::Session> framework.
Catalyst Contributors, see Catalyst.pm
This library is free software. You can redistribute it and/or modify it under the same terms as Perl itself.