Catalyst::Manual::Plugins - Catalyst Plugins (and Components)
This section lists the some of the plugins and components that are available to extend the runtime functionality of Catalyst. Most plugins 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 now part of core Catalyst. Be sure to check the Catalyst::Plugin namespace for additional plugins 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.
Catalyst::Plugin::Authentication::Credential::Atom is a plugin which implements WSSE and Basic authentication for Catalyst applications using Catalyst::Plugin::AtomServer
Provides authentication via Flickr, using its API.
Implements HTTP Basic authentication for Catalyst.
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.
Integrates Authen::TypeKey with Catalyst::Plugin::Authentication.
Catalyst::Plugin::Authentication::OpenID is a plugin that implements support for OpenID authentication. For more information on OpenID, take a look at http://www.openid.net/.
The core authentication store documentation.
Does authentication and authorization against a DBIx::Class or Class::DBI model.
Uses Authen::Htpasswd to let your application use .htpasswd files for its authentication storage.
.htpasswd
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.
An easy authentication user object based on hashes. See Catalyst::Plugin::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::Authorization::Roles provides role based authorization for Catalyst based on Catalyst::Plugin::Authentication.
Extends Catalyst::Request by adding the capability of browser detection. It returns an instance of HTTP::BrowserDetect, which lets you get information from the client's user agent.
Catalyst::Plugin::Cache::FastMmap, Catalyst::Plugin::Cache::FileCache, Catalyst::Plugin::Cache::BerkeleyDB, and Catalyst::Plugin::Cache::Memcached all provide a cache method enabling easy access to a shared cache.
Provides a standard method for loading config files. Support exists for various formats. See Catalyst::Plugin::ConfigLoader::INI, Catalyst::Plugin::ConfigLoader::JSON, Catalyst::Plugin::ConfigLoader::Perl, Catalyst::Plugin::ConfigLoader::XML, and Catalyst::Plugin::ConfigLoader::YAML
Creates a sane, standard end method for your application.
Sends email with Email::Send and Email::MIME::Creator.
A plugin based on HTML::FillInForm, which describes itself as a module to automatically insert data from a previous HTML form into the HTML input, textarea, radio buttons, checkboxes, 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.
HTML::FillInForm
HTML::Parser
A form validator plugin that uses Data::FormValidator to validate and set up form data from your request parameters. It's a quite thin wrapper around that module, so most of the relevant information can be found there.
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. Supports mo/po files and Maketext classes under your application's I18N namespace.
mo
po
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.
A plugin for the Prototype JavaScript library. This Plugin allows you to easily implement AJAX functionality without actually knowing Javascript.
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 (explain, scan, and searchRetrieve) from its own class.
explain
scan
searchRetrieve
Catalyst::Plugin::Static is a plugin to serve static files from $c->config->{root}. Intended chiefly for development purposes.
$c->config->{root}
Serves static files in your application without requiring a single line of code. This plugin is now included in the core Catalyst distribution.
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.
A persistent Textile processor for Catalyst that uses Text::Textile, a Perl-based implementation of Dean Allen's Textile syntax. Textile is shorthand for doing common formatting tasks (see http://textism.com).
Text::Textile
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.
Allows your Controller class to dispatch XMLRPC methods from its own class.
Lets you mark lexical variables with a Stashed attribute, automatically passing them to the stash.
Stashed
The Class::DBI (CDBI) model class. It is built on top of Class::DBI::Loader, which automates the definition of Class::DBI sub-classes by scanning the underlying table schemas, setting up columns and primary keys.
Class::DBI
Class::DBI::Loader
A neutral interface to the Class::DBI module which does not attempt to automate table setup. It allows the user to manually set up Class::DBI classes, either by doing so within the Catalyst model classes themselves, or by inheriting from existing Class::DBI classes.
A DBIx::Class model class that can use either an explicit DBIx::Class::Schema or one automatically loaded from your database via DBIx::Class::Schema::Loader.
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.
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::Store::LDAP.
Replaced by Catalyst::Plugin::Authentication.
The Catalyst::Plugin::Config::JSON and Catalyst::Plugin::Config::YAML modules have been replaced by their corresponding Catalyst::Plugin::ConfigLoader modules.
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.
Andrew Ford <A.Ford@ford-mason.co.uk>
Gavin Henry <ghenry@suretecsystems.com>
Jesse Sheidlower <jester@panix.com>
Marcus Ramberg <mramberg@cpan.org>
David Kamholz <dkamholz@cpan.org>
This program is free software, you can redistribute it and/or modify it under the same terms as Perl itself.
To install Catalyst::Runtime, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Catalyst::Runtime
CPAN shell
perl -MCPAN -e shell install Catalyst::Runtime
For more information on module installation, please visit the detailed CPAN module installation guide.