Catalyst::Manual::Plugins - Catalyst Plugins


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 is almost certainly outdated by the time you read this and some plugins may even 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

Catalyst::Plugin::Account::AutoDiscovery

the Catalyst::Plugin::Account::AutoDiscovery manpage provides Account Auto-Discovery for Catalyst.

Catalyst::Plugin::Acme::Scramble

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.

Catalyst::Plugin::AtomPP

the Catalyst::Plugin::AtomPP manpage allows you to dispatch AtomPP methods.

Catalyst::Plugin::AtomServer

the Catalyst::Plugin::AtomServer manpage is a plugin that implements the necessary bits to make it easy to build an Atom API server for any Catalyst-based application.

Catalyst::Plugin::Authentication

the Catalyst::Plugin::Authentication manpage is a infrastructure plugin for the Catalyst authentication framework. Now the recommended way to do any form of Authentication.

Catalyst::Plugin::Authentication::Basic::Remote

the Catalyst::Plugin::Authentication::Basic::Remote manpage is a authentication plugin that allows you to use a remote host's Basic authentication.

Catalyst::Plugin::Authentication::CDBI

the Catalyst::Plugin::Authentication::CDBI manpage is a CDBI (Class::DBI) authentication plugin. Note that it requires a session plugin.

Catalyst::Plugin::Authentication::CDBI::Basic

the Catalyst::Plugin::Authentication::CDBI::Basic manpage provides Basic Authorization for Catalyst. Replaced by the Catalyst::Plugin::Authentication::Credential::HTTP manpage

Catalyst::Plugin::Authentication::Credential::Atom

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

Catalyst::Plugin::Authentication::Credential::Flickr

the Catalyst::Plugin::Authentication::Credential::Flickr manpage is a plugin which provides authentication via Flickr, using it's API

Catalyst::Plugin::Authentication::Credential::HTTP

the Catalyst::Plugin::Authentication::Credential::HTTP manpage is a plugin that lets you do HTTP Basic authentication for Catalyst.

Catalyst::Plugin::Authentication::Credential::Password

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

Catalyst::Plugin::Authentication::Credential::TypeKey

the Catalyst::Plugin::Authentication::Credential::TypeKey manpage integrates the Authen::TypeKey manpage with the Catalyst::Plugin::Authentication manpage

Catalyst::Plugin::Authentication::LDAP

the Catalyst::Plugin::Authentication::LDAP manpage is a plugin allowing you to authenticate your web users using an LDAP server. Replaced by the Catalyst::Plugin::Authentication::Store::LDAP manpage

Catalyst::Plugin::Authentication::OpenID

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

Catalyst::Plugin::Authentication::Simple

Replaced by new the Catalyst::Plugin::Authentication manpage framework

Catalyst::Plugin::Authentication::Store

the Catalyst::Plugin::Authentication::Store manpage is the core store documentation

Catalyst::Plugin::Authentication::Store::DBIC

the Catalyst::Plugin::Authentication::Store::DBIC manpage is a plugin that lets you do authentication and authorization against a DBIx::Class or Class::DBI model.

Catalyst::Plugin::Authentication::Store::Htpasswd

the Catalyst::Plugin::Authentication::Store::Htpasswd manpage uses the Authen::Htpasswd manpage to let your application use .htpasswd files for it's authentication storage.

Catalyst::Plugin::Authentication::Store::LDAP

the Catalyst::Plugin::Authentication::Store::LDAP manpage the new LDAP store. Use this instead of the Catalyst::Plugin::Authentication::LDAP manpage

Catalyst::Plugin::Authentication::Store::Minimal

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.

Catalyst::Plugin::Authentication::User::Hash

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

Catalyst::Plugin::Authorization::ACL

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.

Catalyst::Plugin::Authorization::CDBI::GroupToken

No longer on the CPAN

Catalyst::Plugin::Authorization::Roles

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

Catalyst::Plugin::Browser

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, and Memcached

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

Catalyst::Plugin::CDBI::Transaction

Catalyst::Plugin::Charsets::Japanese

Catalyst::Plugin::Compress::Bzip2

the Catalyst::Plugin::Compress::Bzip2 manpage compresses a response using bzip compression.

Catalyst::Plugin::Compress::Deflate

Catalyst::Plugin::Compress::Gzip

Catalyst::Plugin::Compress::Zlib

the Catalyst::Plugin::Compress::Zlib manpage supplies Zlib compression for Catalyst.

Catalyst::Plugin::Config::JSON

Catalyst::Plugin::ConfigLoader

Catalyst::Plugin::ConfigLoader::INI

Catalyst::Plugin::ConfigLoader::JSON

Catalyst::Plugin::ConfigLoader::Perl

Catalyst::Plugin::ConfigLoader::XML

Catalyst::Plugin::ConfigLoader::YAML

Catalyst::Plugin::Config::YAML

Catalyst::Plugin::DateTime

Catalyst::Plugin::DefaultEnd

the Catalyst::Plugin::DefaultEnd manpage creates a sane, standard end method for your application.

Catalyst::Plugin::Devel::InPageLogs

Catalyst::Plugin::Devel::InPageLogs::Log

Catalyst::Plugin::Dumper

Catalyst::Plugin::Email

the Catalyst::Plugin::Email manpage sends email with Catalyst and the Email::Send manpage and the Email::MIME::Creator manpage.

Catalyst::Plugin::Email::Japanese

Catalyst::Plugin::Email::Page

Catalyst::Plugin::EmailValid

Catalyst::Plugin::FillInForm

the Catalyst::Plugin::FillInForm manpage is plugin for Catalyst 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.

Catalyst::Plugin::Flavour

Catalyst::Plugin::FormValidator

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

Catalyst::Plugin::FormValidator::Simple

Catalyst::Plugin::Geography

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.

Catalyst::Plugin::Geography::Implementation

Catalyst::Plugin::HashedCookies

Catalyst::Plugin::HTML::Scrubber

Catalyst::Plugin::HTML::Widget

Catalyst::Plugin::I18N

the Catalyst::Plugin::I18N manpage is an internationalization plugin for Catalyst. Supports mo/po files and Maketext classes under your application's I18N namespace.

Catalyst::Plugin::JSONRPC

Catalyst::Plugin::Message

Catalyst::Plugin::MobileAgent

Catalyst::Plugin::Observe

the Catalyst::Plugin::Observe manpage provides the ability to register AOP-like callbacks to specific Engine events. Subclasses the Class::Publisher manpage.

Catalyst::Plugin::OrderedParams

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.

Catalyst::Plugin::PageCache

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.

Catalyst::Plugin::Params::Nested

Catalyst::Plugin::Params::Nested::Expander

Catalyst::Plugin::Pluggable

the Catalyst::Plugin::Pluggable manpage is a plugin for pluggable Catalyst applications.

Catalyst::Plugin::Prototype

the Catalyst::Plugin::Prototype manpage is a plugin for the Prototype JavaScript library. This Plugin allows you to easily implement AJAX functionality without actually knowing Javascript.

Catalyst::Plugin::Redirect

Catalyst::Plugin::RequestToken

Catalyst::Plugin::RequireSSL

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

Catalyst::Plugin::SanitizeUrl

Catalyst::Plugin::SanitizeUrl::PrepAction

Catalyst::Plugin::Scheduler

Catalyst::Plugin::Session

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.

Catalyst::Plugin::Session::CGISession

Catalyst::Plugin::Session::FastMmap

the Catalyst::Plugin::Session::FastMmap manpage is a session plugin for Catalyst based on Cache::FastMMap, which uses an mmap'ed file to act as a shared memory interprocess cache. This is an older session plugin; you may wish to look at the Catalyst::Plugin::Session manpage instead.

Catalyst::Plugin::Session::Flex

Catalyst::Plugin::Session::Manager

Catalyst::Plugin::Session::Manager::Client::Cookie

Catalyst::Plugin::Session::Manager::Client::Rewrite

Catalyst::Plugin::Session::Manager::Client::StickyQuery

Catalyst::Plugin::Session::Manager::Storage::CDBI

Catalyst::Plugin::Session::Manager::Storage::FastMmap

Catalyst::Plugin::Session::Manager::Storage::File

Catalyst::Plugin::Session::PerUser

Catalyst::Plugin::Session::State

Catalyst::Plugin::Session::State::Cookie

Catalyst::Plugin::Session::State::URI

Catalyst::Plugin::Session::Store

Catalyst::Plugin::Session::Store::CDBI

Catalyst::Plugin::Session::Store::DBI

Catalyst::Plugin::Session::Store::Dummy

Catalyst::Plugin::Session::Store::FastMmap

Catalyst::Plugin::Session::Store::File

Catalyst::Plugin::Session::Store::Memcached

Catalyst::Plugin::Session::Test::Store

Catalyst::Plugin::Singleton

Catalyst::Plugin::SRU

the Catalyst::Plugin::SRU manpage allows your controller class to dispatch SRU actions (explain, scan, and searchRetrieve) from its own class.

Catalyst::Plugin::StackTrace

Catalyst::Plugin::Static

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

Catalyst::Plugin::Static::Simple

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.

Catalyst::Plugin::SubRequest

the Catalyst::Plugin::SubRequest manpage is a plugin to allow subrequests to actions to be made within Catalyst. Nice for portal software and such.

Catalyst::Plugin::SuperForm

the Catalyst::Plugin::SuperForm manpage is an interface to the the HTML::SuperForm manpage module, enabling easy HTML form creation.

Catalyst::Plugin::Textile

the Catalyst::Plugin::Textile manpage is 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).

Catalyst::Plugin::Unicode

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.

Catalyst::Plugin::Unicode::Encoding

Catalyst::Plugin::Upload::Basename

Catalyst::Plugin::Upload::MD5

Catalyst::Plugin::Upload::MIME

Catalyst::Plugin::XMLRPC

the Catalyst::Plugin::XMLRPC manpage plugin allows your Controller class to dispatch XMLRPC methods from its own class.


COMPONENT MODULES

Catalyst::Model::CDBI

the Catalyst::Model::CDBI manpage is the Class::DBI (CDBI) module 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.

Catalyst::Model::CDBI::Plain

the Catalyst::Model::CDBI::Plain manpage is 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.

Catalyst::Model::DBIC

the Catalyst::Model::DBIC manpage is a the DBIx::Class manpage model class built on top of the DBIx::Class::Loader manpage.

Catalyst::Model::Plucene

the Catalyst::Model::Plucene manpage is a model class for the Plucene search engine.

Catalyst::Model::Xapian

the Catalyst::Model::Xapian manpage is a model class for the Xapian search engine.

Catalyst::View::HTML::Template

the Catalyst::View::HTML::Template manpage is a View component for displaying your stash with the HTML::Template manpage.

Catalyst::View::Mason

the Catalyst::View::Mason manpage is a View component for displaying your stash with the HTML::Mason manpage.

Catalyst::View::PSP

the Catalyst::View::PSP manpage is a View component for displaying your stash using PSP, a Perl extension implementing a JSP-like templating system; see the Text::PSP manpage.

Catalyst::View::Petal

the Catalyst::View::Petal manpage is a View component for displaying your stash using Petal, the Perl Template Attribute Language, an XML-based templating system; see Petal.

Catalyst::View::TT

the Catalyst::View::TT manpage is a Template Toolkit view. See the Template::Manual manpage.


AUTHORS

Andrew Ford <A.Ford@ford-mason.co.uk>

Gavin Henry <ghenry@suretecsystems.com>

Jesse Sheidlower <jester@panix.com>

Marcus Ramberg <mramberg@cpan.org>


COPYRIGHT

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

 Catalyst::Manual::Plugins - Catalyst Plugins