NAME

Catalyst::Manual::Plugins - Catalyst Plugins (and Components)


DESCRIPTION

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.


PLUGINS

the Catalyst::Plugin::Account::AutoDiscovery manpage

Provides Account Auto-Discovery for Catalyst.

the Catalyst::Plugin::Acme::Scramble manpage

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.

the Catalyst::Plugin::Alarm manpage

the Catalyst::Plugin::AtomPP manpage

Allows you to dispatch AtomPP methods.

the Catalyst::Plugin::AtomServer manpage

A plugin that implements the necessary bits to make it easy to build an Atom API server for any Catalyst-based application.

the Catalyst::Plugin::Authentication manpage

An infrastructure plugin for the Catalyst authentication framework. Now the recommended way to do any form of Authentication.

the Catalyst::Plugin::Authentication::Credential::Atom manpage

the Catalyst::Plugin::Authentication::Credential::Atom manpage is a plugin which implements WSSE and Basic authentication for Catalyst applications using the Catalyst::Plugin::AtomServer manpage

the Catalyst::Plugin::Authentication::Credential::CHAP manpage

the Catalyst::Plugin::Authentication::Credential::Flickr manpage

Provides authentication via Flickr, using its API.

the Catalyst::Plugin::Authentication::Credential::Hatena manpage

the Catalyst::Plugin::Authentication::Credential::HTTP manpage

Implements HTTP Basic authentication for Catalyst.

the Catalyst::Plugin::Authentication::Credential::JugemKey manpage

the Catalyst::Plugin::Authentication::Credential::PAM manpage

the Catalyst::Plugin::Authentication::Credential::Password manpage

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 the Catalyst::Plugin::Authentication manpage.

the Catalyst::Plugin::Authentication::Credential::TypeKey manpage

Integrates the Authen::TypeKey manpage with the Catalyst::Plugin::Authentication manpage.

the Catalyst::Plugin::Authentication::OpenID manpage

the Catalyst::Plugin::Authentication::OpenID manpage is a plugin that implements support for OpenID authentication. For more information on OpenID, take a look at http://www.openid.net/.

the Catalyst::Plugin::Authentication::Store manpage

The core authentication store documentation.

the Catalyst::Plugin::Authentication::Store::DBIC manpage

Does authentication and authorization against a the DBIx::Class manpage or the Class::DBI manpage model.

the Catalyst::Plugin::Authentication::Store::Htpasswd manpage

Uses the Authen::Htpasswd manpage to let your application use .htpasswd files for its authentication storage.

the Catalyst::Plugin::Authentication::Store::HTTP manpage

the Catalyst::Plugin::Authentication::Store::LDAP manpage

Authenticates users using an LDAP server.

the Catalyst::Plugin::Authentication::Store::Minimal manpage

Lets you create a very quick and dirty user database in your application's config hash. Great for getting up and running quickly.

the Catalyst::Plugin::Authentication::User::Hash manpage

An easy authentication user object based on hashes. See the Catalyst::Plugin::Authentication::Store::Minimal manpage for more info.

the Catalyst::Plugin::Authorization::ACL manpage

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.

the Catalyst::Plugin::Authorization::Roles manpage

the Catalyst::Plugin::Authorization::Roles manpage provides role based authorization for Catalyst based on the Catalyst::Plugin::Authentication manpage.

the Catalyst::Plugin::AutoSession manpage

the Catalyst::Plugin::Browser manpage

Extends the Catalyst::Request manpage by adding the capability of browser detection. It returns an instance of the HTTP::BrowserDetect manpage, which lets you get information from the client's user agent.

Catalyst::Plugin::Cache::FastMmap, FileCache, BerkeleyDB, and Memcached

the Catalyst::Plugin::Cache::FastMmap manpage, the Catalyst::Plugin::Cache::FileCache manpage, the Catalyst::Plugin::Cache::BerkeleyDB manpage, and the Catalyst::Plugin::Cache::Memcached manpage all provide a cache method enabling easy access to a shared cache.

the Catalyst::Plugin::Captcha manpage

the Catalyst::Plugin::CGI::Untaint manpage

the Catalyst::Plugin::Charsets::Japanese manpage

the Catalyst::Plugin::Compress::Bzip2 manpage

the Catalyst::Plugin::Compress::Deflate manpage

the Catalyst::Plugin::Compress::Gzip manpage

the Catalyst::Plugin::Compress::Zlib manpage

the Catalyst::Plugin::ConfigLoader manpage

Provides a standard method for loading config files. Support exists for various formats. See the Catalyst::Plugin::ConfigLoader::INI manpage, the Catalyst::Plugin::ConfigLoader::JSON manpage, the Catalyst::Plugin::ConfigLoader::Perl manpage, the Catalyst::Plugin::ConfigLoader::XML manpage, and the Catalyst::Plugin::ConfigLoader::YAML manpage

the Catalyst::Plugin::ConfigurablePathTo manpage

the Catalyst::Plugin::Continuation manpage

the Catalyst::Plugin::DateTime manpage

the Catalyst::Plugin::DefaultEnd manpage

Creates a sane, standard end method for your application.

the Catalyst::Plugin::Devel::InPageLogs manpage

the Catalyst::Plugin::Devel::InPageLogs::Log manpage

the Catalyst::Plugin::Dojo manpage

the Catalyst::Plugin::Dumper manpage

the Catalyst::Plugin::Email manpage

Sends email with the Email::Send manpage and the Email::MIME::Creator manpage.

the Catalyst::Plugin::Email::Japanese manpage

the Catalyst::Plugin::Email::Page manpage

the Catalyst::Plugin::EmailValid manpage

the Catalyst::Plugin::FillInForm manpage

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.

the Catalyst::Plugin::Flavour manpage

the Catalyst::Plugin::FormValidator manpage

A form validator plugin that uses the Data::FormValidator manpage 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.

the Catalyst::Plugin::FormValidator::Simple manpage

the Catalyst::Plugin::Geography manpage

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.

the Catalyst::Plugin::Geography::Implementation manpage

the Catalyst::Plugin::HashedCookies manpage

the Catalyst::Plugin::HTML::Scrubber manpage

the Catalyst::Plugin::HTML::Widget manpage

the Catalyst::Plugin::I18N manpage

An internationalization plugin for Catalyst. Supports mo/po files and Maketext classes under your application's I18N namespace.

the Catalyst::Plugin::JSONRPC manpage

the Catalyst::Plugin::Markdown manpage

the Catalyst::Plugin::Message manpage

the Catalyst::Plugin::MobileAgent manpage

the Catalyst::Plugin::Observe manpage

Provides the ability to register AOP-like callbacks to specific Engine events. Subclasses the Class::Publisher manpage.

the Catalyst::Plugin::OrderedParams manpage

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.

the Catalyst::Plugin::PageCache manpage

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.

the Catalyst::Plugin::Params::Nested manpage

the Catalyst::Plugin::Params::Nested::Expander manpage

the Catalyst::Plugin::Pluggable manpage

A plugin for pluggable Catalyst applications.

the Catalyst::Plugin::Prototype manpage

A plugin for the Prototype JavaScript library. This Plugin allows you to easily implement AJAX functionality without actually knowing Javascript.

the Catalyst::Plugin::Redirect manpage

the Catalyst::Plugin::RequestToken manpage

the Catalyst::Plugin::RequireSSL manpage

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::Scheduler manpage

the Catalyst::Plugin::Session manpage

The the Catalyst::Plugin::Session manpage 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.

the Catalyst::Plugin::Session::PerUser manpage

the Catalyst::Plugin::Session::State manpage

the Catalyst::Plugin::Session::State::Cookie manpage

the Catalyst::Plugin::Session::State::URI manpage

the Catalyst::Plugin::Session::Store manpage

the Catalyst::Plugin::Session::Store::CDBI manpage

the Catalyst::Plugin::Session::Store::DBI manpage

the Catalyst::Plugin::Session::Store::DBIC manpage

the Catalyst::Plugin::Session::Store::Dummy manpage

the Catalyst::Plugin::Session::Store::FastMmap manpage

the Catalyst::Plugin::Session::Store::File manpage

the Catalyst::Plugin::Session::Store::Memcached manpage

the Catalyst::Plugin::Session::Test::Store manpage

the Catalyst::Plugin::Singleton manpage

the Catalyst::Plugin::Snippets manpage

the Catalyst::Plugin::SRU manpage

Allows your controller class to dispatch SRU actions (explain, scan, and searchRetrieve) from its own class.

the Catalyst::Plugin::StackTrace manpage

the Catalyst::Plugin::Static manpage

the Catalyst::Plugin::Static manpage is a plugin to serve static files from $c->config->{root}. Intended chiefly for development purposes.

the Catalyst::Plugin::Static::Simple manpage

Serves static files in your application without requiring a single line of code. This plugin is now included in the core Catalyst distribution.

the Catalyst::Plugin::SubRequest manpage

A plugin to allow subrequests to actions to be made within Catalyst. Nice for portal software and such.

the Catalyst::Plugin::SuperForm manpage

An interface to the the HTML::SuperForm manpage module, enabling easy HTML form creation.

the Catalyst::Plugin::Textile manpage

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).

the Catalyst::Plugin::Unicode manpage

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.

the Catalyst::Plugin::Unicode::Encoding manpage

the Catalyst::Plugin::Upload::Basename manpage

the Catalyst::Plugin::Upload::MD5 manpage

the Catalyst::Plugin::Upload::MIME manpage

the Catalyst::Plugin::UploadProgress manpage

the Catalyst::Plugin::XMLRPC manpage

Allows your Controller class to dispatch XMLRPC methods from its own class.


CONTROLLERS

the Catalyst::Controller::BindLex manpage

Lets you mark lexical variables with a Stashed attribute, automatically passing them to the stash.


MODELS

the Catalyst::Model::CDBI manpage

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.

the Catalyst::Model::CDBI::Plain manpage

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.

the Catalyst::Model::DBIC::Schema manpage

A the DBIx::Class manpage model class that can use either an explicit the DBIx::Class::Schema manpage or one automatically loaded from your database via the DBIx::Class::Schema::Loader manpage.

the Catalyst::Model::EVDB manpage

the Catalyst::Model::File manpage

the Catalyst::Model::Gedcom manpage

the Catalyst::Model::LDAP manpage

the Catalyst::Model::NetBlogger manpage

the Catalyst::Model::Plucene manpage

A model class for the Plucene search engine.

the Catalyst::Model::Proxy manpage

the Catalyst::Model::SVN manpage

the Catalyst::Model::Xapian manpage

A model class for the Xapian search engine.


VIEWS

the Catalyst::View::Atom::XML manpage

the Catalyst::View::Chart::Strip manpage

the Catalyst::View::CSS::Squish manpage

the Catalyst::View::Embperl manpage

the Catalyst::View::GD::Barcode manpage

the Catalyst::View::GraphViz manpage

the Catalyst::View::HTML::Template manpage

A view component for rendering pages with the HTML::Template manpage.

the Catalyst::View::Jemplate manpage

the Catalyst::View::JSON manpage

the Catalyst::View::Mason manpage

A view component for rendering pages with the HTML::Mason manpage.

the Catalyst::View::MicroMason manpage

the Catalyst::View::PHP manpage

the Catalyst::View::PSP manpage

A view component for rendering pages using PSP, a Perl extension implementing a JSP-like templating system. See the Text::PSP manpage.

the Catalyst::View::Petal manpage

A view component for rendering pages using Petal, the Perl Template Attribute Language, an XML-based templating system. See Petal.

the Catalyst::View::TT manpage

A view component for rendering pages with Template Toolkit. See the Template::Manual manpage.

the Catalyst::View::XSLT manpage

the Catalyst::View::vCard manpage


OBSOLETE MODULES

the Catalyst::Model::DBIC manpage

Replaced by the Catalyst::Model::DBIC::Schema manpage.

the Catalyst::Plugin::Authentication::Basic::Remote manpage

Replaced by the Catalyst::Plugin::Authentication::Credential::HTTP manpage.

the Catalyst::Plugin::Authentication::CDBI manpage

Replaced by the Catalyst::Plugin::Authentication::Store::DBIC manpage.

the Catalyst::Plugin::Authentication::CDBI::Basic manpage

Replaced by the Catalyst::Plugin::Authentication::Credential::HTTP manpage.

the Catalyst::Plugin::Authentication::LDAP manpage

Replaced by the Catalyst::Plugin::Authentication::Store::LDAP manpage.

the Catalyst::Plugin::Authentication::Simple manpage

Replaced by the Catalyst::Plugin::Authentication manpage.

the Catalyst::Plugin::Authorization::CDBI::GroupToken manpage

the Catalyst::Plugin::CDBI::Transaction manpage

Catalyst::Plugin::Config::*

The the Catalyst::Plugin::Config::JSON manpage and the Catalyst::Plugin::Config::YAML manpage modules have been replaced by their corresponding the Catalyst::Plugin::ConfigLoader manpage modules.

the Catalyst::Plugin::DefaultEnd manpage

Replaced by the Catalyst::Action::RenderView manpage

the Catalyst::Plugin::SanitizeUrl manpage

the Catalyst::Plugin::SanitizeUrl::PrepAction manpage

Catalyst::Plugin::Session::*

The the Catalyst::Plugin::Session::CGISession manpage, the Catalyst::Plugin::Session::FastMmap manpage, the Catalyst::Plugin::Session::Flex manpage, and the Catalyst::Plugin::Session::Manager manpage modules have been replaced by the <Catalyst::Plugin::Session> framework.


AUTHORS

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>


COPYRIGHT

This program is free software, you can redistribute it and/or modify it under the same terms as Perl itself.