lib/Catalyst/Manual/Plugins.pod

   1 =head1 NAME
   2
   3 Catalyst::Manual::Plugins - Catalyst Plugins (and Components)
   4
   5 =head1 DESCRIPTION
   6
   7 This section lists the some of the plugins and components that are
   8 available to extend the runtime functionality of Catalyst. The plugins
   9 are not distributed with Catalyst but should be available from CPAN.
  10 They typically require additional modules from CPAN.
  11
  12 =head1 PLUGINS
  13
  14 =head2 Catalyst::Plugin::Authentication::CDBI
  15
  16 L<Catalyst::Plugin::Authentication::CDBI> is a CDBI (C<Class::DBI>)
  17 authentication plugin.  Note that it requires a session plugin.
  18
  19 =head2 Catalyst::Plugin::Email
  20
  21 L<Catalyst::Plugin::Email> sends email with Catalyst and L<Email::Send>
  22 and L<Email::MIME::Creator>.
  23
  24 =head2 Catalyst::Plugin::FillInForm
  25
  26 L<Catalyst::Plugin::FillInForm> is plugin for Catalyst based on
  27 C<HTML::FillInForm>, which describes itself as a module to automatically
  28 insert data from a previous HTML form into the HTML input, textarea,
  29 radio buttons, checkboxes, and select tags.  C<HTML::FillInForm> is a
  30 subclass of C<HTML::Parser> and uses it to parse the HTML and insert the
  31 values into the form tags.
  32
  33 =head2 Catalyst::Plugin::FormValidator
  34
  35 L<Catalyst::Plugin::FormValidator> is a form validator plugin that uses
  36 L<Data::FormValidator> to validate and set up form data from your
  37 request parameters.  It's a quite thin wrapper around that module, so
  38 most of the relevant information can be found there.
  39
  40
  41 =head2 Catalyst::Plugin::I18N
  42
  43 L<Catalyst::Plugin::I18N> is an internationalization plugin for
  44 Catalyst.  Supports C<mo>/C<po> files and Maketext classes under your
  45 application's I18N namespace.
  46
  47
  48 =head2 Catalyst::Plugin::Pluggable
  49
  50 L<Catalyst::Plugin::Pluggable> is a plugin for pluggable Catalyst
  51 applications.
  52
  53 =head2 Catalyst::Plugin::Prototype
  54
  55 L<Catalyst::Plugin::Prototype> is a plugin for the Prototype JavaScript
  56 library. This Plugin allows you to easily implement AJAX functionality
  57 without actually knowing Javascript.
  58
  59 =head2 Catalyst::Plugin::Session::FastMmap
  60
  61 L<Catalyst::Plugin::Session::FastMmap> is a session plugin for Catalyst
  62 based on C<Cache::FastMMap>, which uses an mmap'ed file to act as a
  63 shared memory interprocess cache.
  64
  65
  66 =head2 Catalyst::Plugin::Static
  67
  68 L<Catalyst::Plugin::Static> is a plugin to serve static files from C<<
  69 $c->config->{root} >>/<< action >>/.
  70
  71
  72 =head2 Catalyst::Plugin::SubRequest
  73
  74 L<Catalyst::Plugin::SubRequest> is a plugin to allow subrequests to
  75 actions to be made within Catalyst.  Nice for portal software and such.
  76
  77
  78 =head2 Catalyst::Plugin::Textile
  79
  80 L<Catalyst::Plugin::Textile> is a persistent Textile processor for
  81 Catalyst that uses C<Text::Textile>, a Perl-based implementation of Dean
  82 Allen's Textile syntax. Textile is shorthand for doing common formatting
  83 tasks (see L<http://textism.com>).
  84
  85
  86 =head2 Catalyst::Plugin::XMLRPC
  87
  88 L<Catalyst::Plugin::XMLRPC> plugin allows your Controller class to
  89 dispatch XMLRPC methods from its own class.
  90
  91
  92 =head1 COMPONENT MODULES
  93
  94 =head2 Catalyst::Model::CDBI
  95
  96 L<Catalyst::Model::CDBI> is the C<Class::DBI> (CDBI) module class.  It
  97 is built on top of C<Class::DBI::Loader>, which automates the
  98 definition of C<Class::DBI> sub-classes by scanning the underlying
  99 table schemas, setting up columns and primary keys.
 100
 101 =head2 Catalyst::Model::CDBI::Plain
 102
 103 L<Catalyst::Model::CDBI::Plain> is a neutral interface to the
 104 C<Class::DBI> module, which does not attempt to automate table
 105 setup. It allows the user to manually set up C<Class::DBI>
 106 classes, either by doing so within the Catalyst model classes
 107 themselves, or by inheriting from existing C<Class::DBI>
 108 classes.
 109
 110 =head2 Catalyst::Model::CDBI::CRUD
 111
 112 L<Catalyst::Model::CDBI::CRUD> is a subclass of
 113 C<Catalyst::Model::CDBI> with additional CRUD (create, replace,
 114 update, delete) methods.
 115
 116
 117 =head2 Catalyst::View::TT
 118
 119 L<Catalyst::View::TT> is a Template Toolkit view. See
 120 L<Template::Manual>.
 121
 122 =head2 Catalyst::View::Mason
 123
 124 L<Catalyst::View::Mason> allows you to render your stash using
 125 L<HTML::Mason>.
 126
 127 =head1 AUTHOR
 128
 129 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
 130 Marcus Ramberg E<lt>mramberg@cpan.orgE<gt>
 131
 132 =head1 COPYRIGHT
 133
 134 This program is free software, you can redistribute it and/or modify it under
 135 the same terms as Perl itself.