lib/Catalyst/Manual/Components.pod

   1 =head1 NAME
   2
   3 Catalyst::Manual::Component - Reuseable components for Catalyst applications.
   4
   5 =head1 DESCRIPTION
   6
   7 This section lists the some of the components (and plugins) that are
   8 available to extend the runtime functionality of Catalyst. Most components
   9 are not distributed with Catalyst but should be available from CPAN.
  10 They typically require additional modules from CPAN.
  11
  12 This list may well be outdated by the time you read this and some
  13 plugins may be deprecated or now part of core L<Catalyst>. Be sure to
  14 check the Catalyst:: and CatalystX:: namespaces for additional components and consult
  15 the mailing list ( L<http://dev.catalyst.perl.org/wiki/Support> ) for
  16 advice on the current status or preferred use of your chosen
  17 plugin/framework.
  18
  19 =head1 PLUGINS
  20
  21 =head2 L<Catalyst::Plugin::Account::AutoDiscovery>
  22
  23 Provides Account Auto-Discovery for Catalyst.
  24
  25 =head2 L<Catalyst::Plugin::Acme::Scramble>
  26
  27 Implements a potent meme about how easily we can read scrambled text if
  28 the first and last letters remain constant. Operates on text/plain and
  29 text/html served by your Catalyst application.
  30
  31 =head2 L<Catalyst::Plugin::Alarm>
  32
  33 =head2 L<Catalyst::Plugin::AtomPP>
  34
  35 Allows you to dispatch AtomPP methods.
  36
  37 =head2 L<Catalyst::Plugin::AtomServer>
  38
  39 A plugin that implements the necessary bits to make it easy to build an
  40 Atom API server for any Catalyst-based application.
  41
  42 =head2 L<Catalyst::Plugin::Authentication>
  43
  44 An infrastructure plugin for the Catalyst authentication framework. Now the
  45 recommended way to do any form of Authentication.
  46
  47 Note that newer versions of the authentication plugin allow multiple
  48 C<realms>, so that you can authenticate users in different ways in different
  49 parts of your application.
  50
  51 This, however, has involved deprecated all classes in the
  52 C<Catalyst::Plugin::Authentication::Credential::XXX> and
  53 C<Catalyst::Plugin::Authentication::Store::XXX> namespaces.
  54
  55 These plugins are still useable, however they have mostly been
  56 replaced with new modules in the new namespace which will work together.
  57
  58 =head3 Available Credential modules:
  59
  60 =head4 L<Catalyst::Authentication::Credential::AuthTkt>
  61
  62 Allows you to use the L<Apache::AuthTkt> module with Catalyst.
  63
  64 =head4 L<Catalyst::Authentication::Credential::FBConnect>
  65
  66 Allows you to authenticate facebook users using the FBConnect API.
  67
  68 =head4 L<Catalyst::Authentication::Credential::Flickr>
  69
  70 Provides authentication via Flickr, using its API.
  71
  72 =head4 L<Catalyst::Authentication::Credential::HTTP>
  73
  74 Allows you to authenticate users using HTTP Basic or Digest authentication.
  75
  76 =head4 L<Catalyst::Authentication::Credential::HTTP::Proxy>
  77
  78 Allows you to authenticate users against a remote web server
  79 offering HTTP authentication.
  80
  81 =head4 L<Catalyst::Authentication::Credential::Kerberos>
  82
  83 Allows you to authenticate your users against a Kerberos server.
  84
  85 =head4 L<Catalyst::Authentication::Credential::OAuth>
  86
  87 Allows you to authenticate users using their login on other websites supporting
  88 the OAuth protocol.
  89
  90 =head4 L<Catalyst::Authentication::Credential::OpenID>
  91
  92 Allows you to authenticate users using their login on other websites supporting
  93 the OpenID protocol.
  94
  95 =head4 L<Catalyst::Authentication::Credential::Password>
  96
  97 Takes a username (or userid) and a password, and tries various methods of
  98 comparing a password based on what the chosen store's user objects support.
  99 Part of the Authentication Framework L<Catalyst::Plugin::Authentication>.
 100
 101 =head4 L<Catalyst::Authentication::Credential::RPX>
 102
 103 Allows you to autheticate users using the RPX protocol.
 104
 105 =head4 L<Catalyst::Authentication::Credential::Remote>
 106
 107 Allows you to authenticate users in Catalyst which have already been
 108 authenticated by your web server - this is useful for authenticating
 109 users with SSL Client certificates, and using NTLM or any other
 110 authentication protocol natively supported by your web server.
 111
 112 =head4 L<Catalyst::Authentication::Credential::Testing>
 113
 114 Allows you to set the same password for all users, which is useful
 115 when you want to test logging in as multiple users / types of user,
 116 without having to mock things, or set all users passwords in your
 117 test suite.
 118
 119 =head4 L<Catalyst::Authentication::Credential::Authen::Simple>
 120
 121 Allows any of the L<Authen::Simple> family of modules to be used
 122 to authenticate users in Catalyst.
 123
 124 =head3 LAvailable Store modules:
 125
 126 =head4 L<Catalyst::Authentication::Store::DBIx::Class>
 127
 128 Does authentication and authorization against a L<DBIx::Class> model.
 129
 130 =head4 L<Catalyst::Authentication::Store::Htpasswd>
 131
 132 Uses L<Authen::Htpasswd> to let your application use C<.htpasswd> files for its
 133 authentication storage.
 134
 135 =head4 L<Catalyst::Authentication::Store::AuthTkt>
 136
 137 This module implements the Catalyst::Authentication API for L<Apache::AuthTkt>.
 138
 139 =head4 L<Catalyst::Authentication::Store::DBI>
 140
 141 Allows you to use a plain L<DBI> database connection to identify users.
 142
 143 =head4 L<Catalyst::Authentication::Store::Htpasswd>
 144
 145 Allows you to use an apache htpassed type file to authenticate users from.
 146
 147 =head4 L<Catalyst::Authentication::Store::KiokuDB>
 148
 149 Authenticate users stored as objects in the L<KiokuDB> object graph storage
 150 engine system.
 151
 152 =head4 L<Catalyst::Authentication::Store::LDAP>
 153
 154 Authenticates users using an LDAP server.
 155
 156 =head4 L<Catalyst::Authentication::Store::Minimal>
 157
 158 Lets you create a very quick and dirty user database in your application's
 159 config hash. Great for getting up and running quickly.
 160
 161 =head4 L<Catalyst::Authentication::Store::Null>
 162
 163 The Null store is a transparent store where any supplied user data is accepted.
 164 This is mainly useful for remotely authenticating credentials (e.g. OpenID) which
 165 may not be tied to any local storage.
 166
 167 =head4 L<Catalyst::Authentication::Store::RDBO>
 168
 169 Allows access to authentication information stored in a database via a L<Rose::DB::Object> class.
 170
 171 =head4 L<Catalyst::Authentication::Store::Tangram>
 172
 173 Allows access to authentication information stored in a database via a L<Tangram> class.
 174
 175 =head4 L<Catalyst::Authentication::Store::DBIx::Class>
 176
 177 Allows access to authentication information stored in a database via a L<DBIx::Class> class.
 178
 179 =head4 L<Catalyst::Authentication::Store::Jifty::DBI>
 180
 181 Allows access to authentication information stored in a database via a L<Jifty::DBI> class.
 182
 183 =head4 L<Catalyst::Authentication::User::Hash>
 184
 185 An easy authentication user object based on hashes.
 186 See L<Catalyst::Authentication::Store::Minimal> for more info.
 187
 188 =head2 L<Catalyst::Plugin::Authorization::ACL>
 189
 190 This module provides Access Control List style path protection, with arbitrary
 191 rules for L<Catalyst> applications. It operates only on the Catalyst private
 192 namespace, at least at the moment.
 193
 194 =head2 L<Catalyst::Plugin::Authorization::Roles>
 195
 196 L<Catalyst::Plugin::Authorization::Roles> provides role based authorization
 197 for Catalyst based on L<Catalyst::Plugin::Authentication>.
 198
 199 =head2 L<Catalyst::Plugin::AutoSession>
 200
 201 =head2 L<Catalyst::Plugin::Browser>
 202
 203 Extends L<Catalyst::Request> by adding the capability of browser
 204 detection.  It returns an instance of L<HTTP::BrowserDetect>, which lets
 205 you get information from the client's user agent.
 206
 207 =head2 L<Catalyst::Plugin::Cache>
 208
 209 Provides a cache method enabling easy access to a shared cache implementing
 210 the C<< Cache:: >> APO, such as:
 211
 212 =over
 213
 214 =item FastMmap
 215
 216 =item FileCache
 217
 218 =item BerkeleyDB
 219
 220 =item Memcached
 221
 222 =item CHI
 223
 224 =back
 225
 226 =head2 L<Catalyst::Plugin::CGI::Untaint>
 227
 228 =head2 L<Catalyst::Plugin::Charsets::Japanese>
 229
 230 =head2 L<Catalyst::Plugin::Compress::Bzip2>
 231
 232 =head2 L<Catalyst::Plugin::Compress::Deflate>
 233
 234 =head2 L<Catalyst::Plugin::Compress::Gzip>
 235
 236 =head2 L<Catalyst::Plugin::Compress::Zlib>
 237
 238 =head2 L<Catalyst::Plugin::ConfigLoader>
 239
 240 Provides a standard method for loading config files. Support
 241 exists for various formats. See
 242 L<Catalyst::Plugin::ConfigLoader::General>
 243 L<Catalyst::Plugin::ConfigLoader::INI>,
 244 L<Catalyst::Plugin::ConfigLoader::JSON>,
 245 L<Catalyst::Plugin::ConfigLoader::Perl>,
 246 L<Catalyst::Plugin::ConfigLoader::XML>, and
 247 L<Catalyst::Plugin::ConfigLoader::YAML>
 248
 249 =head2 L<Catalyst::Plugin::ConfigurablePathTo>
 250
 251 =head2 L<Catalyst::Plugin::Devel::InPageLogs>
 252
 253 =head2 L<Catalyst::Plugin::Devel::InPageLogs::Log>
 254
 255 =head2 L<Catalyst::Plugin::Dojo>
 256
 257 =head2 L<Catalyst::Plugin::Dumper>
 258
 259 =head2 L<Catalyst::Plugin::Email>
 260
 261 Sends email with L<Email::Send> and L<Email::MIME::Creator>.
 262
 263 =head2 L<Catalyst::Plugin::Email::Japanese>
 264
 265 =head2 L<Catalyst::Plugin::Email::Page>
 266
 267 =head2 L<Catalyst::Plugin::EmailValid>
 268
 269 =head2 L<Catalyst::Plugin::FillInForm>
 270
 271 A plugin based on C<HTML::FillInForm>, which describes itself as a module
 272 to automatically insert data from a previous HTML form into the HTML input,
 273 textarea, radio buttons, checkboxes, and select tags.  C<HTML::FillInForm>
 274 is a subclass of C<HTML::Parser> and uses it to parse the HTML and insert
 275 the values into the form tags.
 276
 277 =head2 L<Catalyst::Plugin::Flavour>
 278
 279 =head2 L<Catalyst::Plugin::Geography>
 280
 281 Allows you to retrieve various kinds of geographical information. You can
 282 retrieve the country or code from the current user, from a given IP
 283 address, or from a given hostname.
 284
 285 =head2 L<Catalyst::Plugin::Geography::Implementation>
 286
 287 =head2 L<Catalyst::Plugin::HashedCookies>
 288
 289 =head2 L<Catalyst::Plugin::HTML::Scrubber>
 290
 291 =head2 L<Catalyst::Plugin::I18N>
 292
 293 An internationalization plugin for Catalyst. Supports C<mo>/C<po> files
 294 and Maketext classes under your application's I18N namespace.
 295
 296 =head2 L<Catalyst::Plugin::JSONRPC>
 297
 298 =head2 L<Catalyst::Plugin::Message>
 299
 300 =head2 L<Catalyst::Plugin::MobileAgent>
 301
 302 =head2 L<Catalyst::Plugin::Observe>
 303
 304 Provides the ability to register AOP-like callbacks to specific Engine
 305 events. Subclasses L<Class::Publisher>.
 306
 307 =head2 L<Catalyst::Plugin::OrderedParams>
 308
 309 Adjusts the way that parameters operate, causing them to appear in the same
 310 order they were submitted by the browser. This can be useful for creating
 311 things such as email forms.
 312
 313 =head2 L<Catalyst::Plugin::PageCache>
 314
 315 Helps improve the performance of slow or frequently accessed pages by
 316 caching the entire output of your page. Subsequent requests to the page
 317 will receive the page very quickly from cache.
 318
 319 =head2 L<Catalyst::Plugin::Params::Nested>
 320
 321 =head2 L<Catalyst::Plugin::Params::Nested::Expander>
 322
 323 =head2 L<Catalyst::Plugin::Pluggable>
 324
 325 A plugin for pluggable Catalyst applications.
 326
 327 =head2 L<Catalyst::Plugin::Prototype>
 328
 329 A plugin for the Prototype JavaScript library. This Plugin allows you to
 330 easily implement AJAX functionality without actually knowing Javascript.
 331
 332 =head2 L<Catalyst::Plugin::Redirect>
 333
 334 =head2 L<Catalyst::Plugin::RequestToken>
 335
 336 =head2 L<Catalyst::Plugin::RequireSSL>
 337
 338 Use this if you would like to force visitors to access certain pages using
 339 only SSL mode. An attempt to access the page in non-SSL mode will receive a
 340 redirect into SSL mode. Useful for login pages, shopping carts, user
 341 registration forms, and other sensitive data.
 342
 343 =head2 L<Catalyst::Plugin::Scheduler>
 344
 345 =head2 L<Catalyst::Plugin::Session>
 346
 347 The L<Catalyst::Plugin::Session> series of modules provide an easy way to
 348 include session handling in an application. You can choose from several
 349 different backend storage methods and combine that with your choice of
 350 client-side storage methods.
 351
 352 =head2 L<Catalyst::Plugin::Session::PerUser>
 353
 354 =head2 L<Catalyst::Plugin::Session::State>
 355
 356 =head2 L<Catalyst::Plugin::Session::State::Cookie>
 357
 358 =head2 L<Catalyst::Plugin::Session::State::URI>
 359
 360 =head2 L<Catalyst::Plugin::Session::Store>
 361
 362 =head2 L<Catalyst::Plugin::Session::Store::CDBI>
 363
 364 =head2 L<Catalyst::Plugin::Session::Store::DBI>
 365
 366 =head2 L<Catalyst::Plugin::Session::Store::DBIC>
 367
 368 =head2 L<Catalyst::Plugin::Session::Store::Dummy>
 369
 370 =head2 L<Catalyst::Plugin::Session::Store::FastMmap>
 371
 372 =head2 L<Catalyst::Plugin::Session::Store::File>
 373
 374 =head2 L<Catalyst::Plugin::Session::Store::Memcached>
 375
 376 =head2 L<Catalyst::Plugin::Session::Test::Store>
 377
 378 =head2 L<Catalyst::Plugin::Singleton>
 379
 380 =head2 L<Catalyst::Plugin::Snippets>
 381
 382 =head2 L<Catalyst::Plugin::SRU>
 383
 384 Allows your controller class to dispatch SRU actions (C<explain>, C<scan>,
 385 and C<searchRetrieve>) from its own class.
 386
 387 =head2 L<Catalyst::Plugin::StackTrace>
 388
 389 =head2 L<Catalyst::Plugin::Static>
 390
 391 L<Catalyst::Plugin::Static> is a plugin to serve static files from
 392 C<< $c->config(root => 'foo') >>. Intended chiefly for development
 393 purposes.
 394
 395 =head2 L<Catalyst::Plugin::Static::Simple>
 396
 397 Serves static files in your application without requiring a single line of
 398 code.
 399
 400 =head2 L<Catalyst::Plugin::SubRequest>
 401
 402 A plugin to allow subrequests to actions to be made within Catalyst. Nice
 403 for portal software and such.
 404
 405 =head2 L<Catalyst::Plugin::SuperForm>
 406
 407 An interface to the L<HTML::SuperForm> module, enabling easy HTML form
 408 creation.
 409
 410 =head2 L<Catalyst::Plugin::Unicode>
 411
 412 Provides a Unicode-aware Catalyst. On request, it decodes all params from
 413 UTF-8 octets into a sequence of logical characters. On response, it encodes
 414 the body into UTF-8 octets.
 415
 416 =head2 L<Catalyst::Plugin::Unicode::Encoding>
 417
 418 =head2 L<Catalyst::Plugin::Upload::Basename>
 419
 420 =head2 L<Catalyst::Plugin::Upload::MD5>
 421
 422 =head2 L<Catalyst::Plugin::Upload::MIME>
 423
 424 =head2 L<Catalyst::Plugin::UploadProgress>
 425
 426 =head2 L<Catalyst::Plugin::XMLRPC>
 427
 428 Allows your Controller class to dispatch XMLRPC methods from its own class.
 429
 430 =head1 CONTROLLERS
 431
 432 =head2 L<Catalyst::Controller::HTML::FormFu>
 433
 434 Catalyst integration for <HTML::FormFu>.
 435
 436 =head1 MODELS
 437
 438 =head2 L<Catalyst::Model::CDBI>
 439
 440 The C<Class::DBI> (CDBI) model class.  It is built on top of
 441 C<Class::DBI::Loader>, which automates the definition of C<Class::DBI>
 442 sub-classes by scanning the underlying table schemas, setting up columns
 443 and primary keys.
 444
 445 =head2 L<Catalyst::Model::CDBI::Plain>
 446
 447 A neutral interface to the C<Class::DBI> module which does not attempt
 448 to automate table setup. It allows the user to manually set up
 449 C<Class::DBI> classes, either by doing so within the Catalyst model
 450 classes themselves, or by inheriting from existing C<Class::DBI>
 451 classes.
 452
 453 =head2 L<Catalyst::Model::DBIC::Schema>
 454
 455 A L<DBIx::Class> model class that can use either an explicit
 456 L<DBIx::Class::Schema> or one automatically loaded from your database
 457 via L<DBIx::Class::Schema::Loader>.
 458
 459 =head2 L<Catalyst::Model::EVDB>
 460
 461 =head2 L<Catalyst::Model::File>
 462
 463 =head2 L<Catalyst::Model::Gedcom>
 464
 465 =head2 L<Catalyst::Model::LDAP>
 466
 467 =head2 L<Catalyst::Model::NetBlogger>
 468
 469 =head2 L<Catalyst::Model::Plucene>
 470
 471 A model class for the Plucene search engine.
 472
 473 =head2 L<Catalyst::Model::Proxy>
 474
 475 =head2 L<Catalyst::Model::SVN>
 476
 477 =head2 L<Catalyst::Model::Xapian>
 478
 479 A model class for the Xapian search engine.
 480
 481 =head1 VIEWS
 482
 483 =head2 L<Catalyst::View::Atom::XML>
 484
 485 =head2 L<Catalyst::View::Chart::Strip>
 486
 487 =head2 L<Catalyst::View::CSS::Squish>
 488
 489 =head2 L<Catalyst::View::Embperl>
 490
 491 =head2 L<Catalyst::View::GD::Barcode>
 492
 493 =head2 L<Catalyst::View::GraphViz>
 494
 495 =head2 L<Catalyst::View::HTML::Template>
 496
 497 A view component for rendering pages with L<HTML::Template>.
 498
 499 =head2 L<Catalyst::View::Jemplate>
 500
 501 =head2 L<Catalyst::View::JSON>
 502
 503 =head2 L<Catalyst::View::Mason>
 504
 505 A view component for rendering pages with L<HTML::Mason>.
 506
 507 =head2 L<Catalyst::View::MicroMason>
 508
 509 =head2 L<Catalyst::View::PHP>
 510
 511 =head2 L<Catalyst::View::PSP>
 512
 513 A view component for rendering pages using PSP, a Perl extension
 514 implementing a JSP-like templating system. See L<Text::PSP>.
 515
 516 =head2 L<Catalyst::View::Petal>
 517
 518 A view component for rendering pages using Petal, the Perl Template
 519 Attribute Language, an XML-based templating system. See L<Petal>.
 520
 521 =head2 L<Catalyst::View::TT>
 522
 523 A view component for rendering pages with Template Toolkit. See
 524 L<Template::Manual>.
 525
 526 =head2 L<Catalyst::View::XSLT>
 527
 528 =head2 L<Catalyst::View::vCard>
 529
 530 =head1 Actions
 531
 532 =head2 L<Catalyst::Action::RenderView>
 533
 534 Creates a sane, standard end method for your application.
 535
 536 =head1 OBSOLETE MODULES
 537
 538 =head2 L<Catalyst::Controller::BindLex>
 539
 540 Lets you mark lexical variables with a C<Stashed> attribute, automatically
 541 passing them to the stash. Discouraged by the author.
 542
 543 =head2 L<Catalyst::Model::DBIC>
 544
 545 Replaced by L<Catalyst::Model::DBIC::Schema>.
 546
 547 =head2 L<Catalyst::Plugin::Authentication::Basic::Remote>
 548
 549 Replaced by L<Catalyst::Plugin::Authentication::Credential::HTTP>.
 550
 551 =head2 L<Catalyst::Plugin::Authentication::CDBI>
 552
 553 Replaced by L<Catalyst::Plugin::Authentication::Store::DBIC>.
 554
 555 =head2 L<Catalyst::Plugin::Authentication::CDBI::Basic>
 556
 557 Replaced by L<Catalyst::Plugin::Authentication::Credential::HTTP>.
 558
 559 =head2 L<Catalyst::Plugin::Authentication::LDAP>
 560
 561 Replaced by L<Catalyst::Plugin::Authentication::Store::LDAP>.
 562
 563 =head2 L<Catalyst::Plugin::Authentication::Simple>
 564
 565 Replaced by L<Catalyst::Plugin::Authentication>.
 566
 567 =head2 L<Catalyst::Plugin::Authorization::CDBI::GroupToken>
 568
 569 =head2 L<Catalyst::Plugin::CDBI::Transaction>
 570
 571 =head2 Catalyst::Plugin::Config::*
 572
 573 The L<Catalyst::Plugin::Config::JSON> and
 574 L<Catalyst::Plugin::Config::YAML> modules have been replaced by their
 575 corresponding L<Catalyst::Plugin::ConfigLoader> modules.
 576
 577 =head2 L<Catalyst::Plugin::DefaultEnd>
 578
 579 Replaced by L<Catalyst::Action::RenderView>
 580
 581 =head2 L<Catalyst::Plugin::SanitizeUrl>
 582
 583 =head2 L<Catalyst::Plugin::SanitizeUrl::PrepAction>
 584
 585 =head2 Catalyst::Plugin::Session::*
 586
 587 The L<Catalyst::Plugin::Session::CGISession>,
 588 L<Catalyst::Plugin::Session::FastMmap>,
 589 L<Catalyst::Plugin::Session::Flex>, and
 590 L<Catalyst::Plugin::Session::Manager>
 591 modules have been replaced by the <Catalyst::Plugin::Session> framework.
 592
 593 =head1 AUTHORS
 594
 595 Catalyst Contributors, see Catalyst.pm
 596
 597 =head1 COPYRIGHT
 598
 599 This library is free software. You can redistribute it and/or modify it under
 600 the same terms as Perl itself.
 601
 602 =cut
 603