Catalys...ponents(3)

📦
version 5.9013 · 7 versions
, in opensuse-leap 16.0

💅 Catalys...ponents(3) — User Contributed Perl Documentation

okay so bestie, this is a perl manpage, and it's literally just a giant list of components. grab a snack 🍓, this one's a long one.

🌸 NAME 🌸

Catalyst::Manual::Components — reuseable components for Catalyst applications ✨

(yes it says "reuseable", that's how it's spelled on the page, we're not fixing her, she's doing her best 😭)

🎀 DESCRIPTION 🎀

okay so real talk: this section lists the some of the components (and plugins) that are available to extend the runtime functionality of Catalyst. think of it as the vibe-check directory of "here's stuff you can bolt on".

  • most components are not distributed with Catalyst, but they should be available from CPAN.
  • they typically require additional modules from CPAN too, so yeah, dependencies on dependencies, classic. 🙈
⚠️ heads up bestie: this list may well be outdated by the time you read this 🫠 and some plugins may be deprecated, or, conversely, may now be part of core Catalyst. be sure to check the Catalyst:: and CatalystX:: namespaces for additional components, and consult the mailing list (http://wiki.catalystframework.org/wiki/Support) for advice on the current status or preferred use of your chosen plugin/framework. no cap, check before you commit.

🔥 PLUGINS 🔥

💀 take care with plugins! in general with a plugin, ask "should this be acting globally on my application?". if not, it should be a Controller Role (e.g. see Catalyst::TraitFor::Controller::reCAPTCHA).

Catalyst::Plugin::Account::AutoDiscovery

Provides Account Auto-Discovery for Catalyst. that's it, that's the whole blurb 🎀

Catalyst::Plugin::Acme::Scramble

Implements a demonstration showing how easily fluent speakers can read scrambled text if the first and last letters remain constant but the middle . (the page literally trails off right there, sentence left hanging, iconic honestly 💀)

Operates on text/plain and text/html served by your Catalyst application. this should really be a controller role, or even a View these days.

Catalyst::Plugin::Alarm

no description on the page, just the name. go read the module, iykyk 🧚

Catalyst::Plugin::AtomPP

Allows you to dispatch AtomPP methods. slay ⭐

Catalyst::Plugin::AtomServer

A plugin that implements the necessary bits to make it easy to build an Atom API server for any Catalyst-based application. very "main character energy" of it.

Catalyst::Plugin::Authentication

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

note that newer versions of the authentication plugin allow multiple "realms", so that you can authenticate users in different ways in different parts of your application. very "different friend groups, different passwords" of it.

this, however, has involved deprecating all classes in the Catalyst::Plugin::Authentication::Credential:: and Catalyst::Plugin::Authentication::Store:: namespaces. 😭

these plugins are still usable, but they have mostly been replaced with new modules in the new namespace which will work together.

Available Credential modules:

  • Catalyst::Authentication::Credential::AuthTkt — Allows you to use the Apache::AuthTkt module with Catalyst.
  • Catalyst::Authentication::Credential::FBConnect — Allows you to authenticate Facebook users using the FBConnect API.
  • Catalyst::Authentication::Credential::Flickr — Provides authentication via Flickr, using its API.
  • Catalyst::Authentication::Credential::HTTP — Allows you to authenticate users using HTTP Basic or Digest authentication.
  • Catalyst::Authentication::Credential::HTTP::Proxy — Allows you to authenticate users against a remote web server offering HTTP authentication.
  • Catalyst::Authentication::Credential::Kerberos — Allows you to authenticate your users against a Kerberos server.
  • Catalyst::Authentication::Credential::OAuth — Allows you to authenticate users using their login on other websites supporting the OAuth protocol.
  • Catalyst::Authentication::Credential::OpenID — Allows you to authenticate users using their login on other websites supporting the OpenID protocol.
  • Catalyst::Authentication::Credential::Password — 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::Authentication::Credential::RPX — Allows you to authenticate users using the RPX protocol.
  • Catalyst::Authentication::Credential::Remote — Allows you to authenticate users in Catalyst that have already been authenticated by your web server. This is useful for authenticating users with SSL Client certificates, and using NTLM or any other authentication protocol natively supported by your web server. 🫶
  • Catalyst::Authentication::Credential::Testing — Allows you to set the same password for all users, which is useful when you want to test logging in as multiple users or multiple types of user, without having to mock things, or set all users' passwords in your test suite. bless this one honestly.
  • Catalyst::Authentication::Credential::Authen::Simple — Allows any of the Authen::Simple family of modules to be used to authenticate users in Catalyst.

Available Store modules:

  • Catalyst::Authentication::Store::DBIx::Class — Does authentication and authorization against a DBIx::Class model.
  • Catalyst::Authentication::Store::Htpasswd — Uses Authen::Htpasswd to let your application use .htpasswd files for its authentication storage.
  • Catalyst::Authentication::Store::AuthTkt — This module implements the Catalyst::Authentication API for Apache::AuthTkt.
  • Catalyst::Authentication::Store::DBI — Allows you to use a plain DBI database connection to identify users.
  • Catalyst::Authentication::Store::Htpasswd — Allows you to use an Apache htpasswd type file to authenticate users. (yes, this one shows up a second time on the page with a different blurb — not me being chaotic, that's genuinely what's written 💀)
  • Catalyst::Authentication::Store::KiokuDB — Authenticate users stored as objects in the KiokuDB object graph storage engine system.
  • Catalyst::Authentication::Store::LDAP — Authenticates users using an LDAP server.
  • Catalyst::Authentication::Store::Minimal — Lets you create a very quick and dirty user database in your application's config hash. Great for testing or getting up and running quickly. lowkey the MVP for prototypes ✨
  • Catalyst::Authentication::Store::Null — The Null store is a transparent store where any supplied user data is accepted. This is mainly useful for remotely authenticating credentials (e.g. OpenID) which may not be tied to any local storage.
  • Catalyst::Authentication::Store::RDBO — Allows access to authentication information stored in a database via a Rose::DB::Object class.
  • Catalyst::Authentication::Store::Tangram — Allows access to authentication information stored in a database via a Tangram class.
  • Catalyst::Authentication::Store::DBIx::Class — Allows access to authentication information stored in a database via a DBIx::Class class. (also a repeat on the page — she's back, and honestly? she ate)
  • Catalyst::Authentication::Store::Jifty::DBI — Allows access to authentication information stored in a database via a Jifty::DBI class.
  • Catalyst::Authentication::User::Hash — An easy authentication user object based on hashes. See Catalyst::Authentication::Store::Minimal for more info.

Catalyst::Plugin::Authorization::ACL

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

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

Catalyst::Plugin::AutoSession

Catalyst::Plugin::AutoSession enables specified request parameters to generate session variables. cute 🎀

Catalyst::Plugin::Browser

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. detective era 🔍

Catalyst::Plugin::Cache

Provides a cache method enabling easy access to a shared cache implementing the Cache:: APO, such as:

  • FastMmap
  • FileCache
  • BerkeleyDB
  • Memcached
  • CHI

Catalyst::Plugin::CGI::Untaint

no description on the page — just the name, bestie. 🙈

Catalyst::Plugin::Charsets::Japanese

Provides specific charset handlers for the Japanese charsets. 🌸

Catalyst::Plugin::Compress::Bzip2

no blurb given, name only.

Catalyst::Plugin::Compress::Deflate

no blurb given, name only.

Catalyst::Plugin::Compress::Gzip

no blurb given, name only.

Catalyst::Plugin::Compress::Zlib

no blurb given, name only. (yes, all four Compress ones are just listed with zero commentary in the original — we love a minimal queen 💅)

Catalyst::Plugin::ConfigLoader

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

Catalyst::Plugin::ConfigurablePathTo

name only, no description on the page.

Catalyst::Plugin::Devel::InPageLogs

name only, no description on the page.

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

name only, no description on the page.

Catalyst::Plugin::Dojo

name only, no description on the page.

Catalyst::Plugin::Dumper

name only, no description on the page.

Catalyst::Plugin::Email::Japanese

name only, no description on the page.

Catalyst::Plugin::Email::Page

name only, no description on the page.

Catalyst::Plugin::FillInForm

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. genuinely so useful, obsessed 🫶

Catalyst::Plugin::Flavour

name only, no description on the page.

Catalyst::Plugin::Geography

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

name only, no description on the page.

Catalyst::Plugin::HashedCookies

name only, no description on the page.

Catalyst::Plugin::HTML::Scrubber

name only, no description on the page.

Catalyst::Plugin::I18N

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

Catalyst::Plugin::JSONRPC

name only, no description on the page.

Catalyst::Plugin::Message

name only, no description on the page.

Catalyst::Plugin::MobileAgent

name only, no description on the page.

Catalyst::Plugin::Observe

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

Catalyst::Plugin::OrderedParams

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. order matters, periodt 💅

Catalyst::Plugin::PageCache

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. speed, she ate. 🔥

Catalyst::Plugin::Params::Nested

name only, no description on the page.

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

name only, no description on the page.

Catalyst::Plugin::Pluggable

A plugin for pluggable Catalyst applications. very meta of her.

Catalyst::Plugin::Prototype

A plugin for the Prototype JavaScript library. This plugin allows you to easily implement AJAX functionality without actually knowing Javascript. not me learning AJAX without learning JS 😭 iconic

Catalyst::Plugin::Redirect

Allows for easy redirecting with the Catalyst app. bye bestie, we're going elsewhere ✨

Catalyst::Plugin::RequestToken

name only, no description on the page.

Catalyst::Plugin::RequireSSL

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. 🔒 protect the data, no cap.

  • Catalyst::Plugin::Scheduler ✨
  • Catalyst::Plugin::Session — okay so this whole series is your easy-mode way to add session handling to an app. You get to choose from several different backend storage methods, and then combine that with whichever client-side storage method you want. 💅
    • 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::DBIC
    • 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::Snippets 🎀
  • Catalyst::Plugin::SRU — lets your controller class dispatch SRU actions ("explain", "scan", and "searchRetrieve") from its own class. iykyk ✨
  • Catalyst::Plugin::StackTrace 🦋
  • Catalyst::Plugin::Static — serves static files out of $c->config(root => 'foo'). It’s intended chiefly for development purposes, bestie. 🛠️
  • Catalyst::Plugin::Static::Simple — serves static files in your app and does it without requiring a single line of code. slay 💅
  • Catalyst::Plugin::SubRequest — a plugin that lets you make subrequests to actions from inside Catalyst. Nice for portal software and such. 🔥
  • Catalyst::Plugin::SuperForm — an interface to the HTML::SuperForm module, enabling easy HTML form creation. 🎀
  • Catalyst::Plugin::Unicode::Encoding — gives you 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 — disrecommended plugin, bestie: it tries to autodetect the uft8ness of the output and do the correct thing. This may work in some cases, but if it helps, you’ve already painted yourself into a corner — try to avoid! 😭
  • Catalyst::Plugin::Upload::Basename 🍓
  • Catalyst::Plugin::Upload::MD5 — computes the MD5 message digest of uploaded files. 💖
  • Catalyst::Plugin::Upload::MIME 🧚
  • Catalyst::Plugin::UploadProgress 🌸
  • Catalyst::Plugin::XMLRPC — lets your Controller class dispatch XMLRPC methods from its own class. 👑

🎮 CONTROLLERS 🎮

  • Catalyst::Controller::HTML::FormFu — the Catalyst integration moment for HTML::FormFu. 💅

🧸 MODELS 🧸

  • Catalyst::Model::CDBI — the Class::DBI (CDBI) model class. It’s 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. iconic ✨
  • Catalyst::Model::CDBI::Plain — a neutral interface to the Class::DBI module that does not attempt to automate table setup. It lets you manually set up Class::DBI classes, either by doing it inside the Catalyst model classes themselves, or by inheriting from existing Class::DBI classes. 🫶
  • Catalyst::Model::DBIC::Schema — 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. 🔥
  • Catalyst::Model::EVDB 🌸
  • Catalyst::Model::File 🎀
  • Catalyst::Model::Gedcom 🦋
  • Catalyst::Model::LDAP 💜
  • Catalyst::Model::NetBlogger 🌈
  • Catalyst::Model::Plucene — a model class for the Plucene search engine. 🔍
  • Catalyst::Model::Proxy 🧚
  • Catalyst::Model::SVN ⭐
  • Catalyst::Model::Xapian — a model class for the Xapian search engine. 🔍

🖼️ VIEWS 🖼️

  • Catalyst::View::Atom::XML ✨
  • Catalyst::View::Chart::Strip 📊
  • Catalyst::View::CSS::Squish 💅
  • Catalyst::View::Embperl 🎀
  • Catalyst::View::GD::Barcode 🧾
  • Catalyst::View::GraphViz 📈
  • Catalyst::View::HTML::Template — a view component for rendering pages with HTML::Template. 💖
  • Catalyst::View::Jemplate 🌸
  • Catalyst::View::JSON 🦋
  • Catalyst::View::Mason — a view component for rendering pages with HTML::Mason. 🫶
  • Catalyst::View::MicroMason 🧚
  • Catalyst::View::PHP 🐘
  • Catalyst::View::PSP — a view component for rendering pages using PSP, a Perl extension implementing a JSP-like templating system. See Text::PSP. 🎀
  • Catalyst::View::Petal — a view component for rendering pages using Petal, the Perl Template Attribute Language, an XML-based templating system. See Petal. 🌺
  • Catalyst::View::TT — a view component for rendering pages with Template Toolkit. See Template::Manual. 💖
  • Catalyst::View::XSLT ✨
  • Catalyst::View::vCard 💌

🎬 Actions 🎬

  • Catalyst::Action::RenderView — creates a sane, standard end method for your application. periodt 💅

💀 OBSOLETE MODULES 💀

  • Catalyst::Controller::BindLex — lets you mark lexical variables with a "Stashed" attribute, automatically passing them to the stash. Discouraged by the author. 🫠
  • Catalyst::Model::DBIC — replaced by Catalyst::Model::DBIC::Schema. 💀
  • Catalyst::Plugin::Authentication::Basic::Remote — replaced by Catalyst::Plugin::Authentication::Credential::HTTP. 💀
  • Catalyst::Plugin::Authentication::CDBI — replaced by Catalyst::Plugin::Authentication::Store::DBIC. 💀
  • Catalyst::Plugin::Authentication::CDBI::Basic — replaced by Catalyst::Plugin::Authentication::Credential::HTTP. 💀
  • Catalyst::Plugin::Authentication::LDAP — replaced by Catalyst::Plugin::Authentication::Store::LDAP. 💀
  • Catalyst::Plugin::Authentication::Simple — replaced by Catalyst::Plugin::Authentication. 💀
  • Catalyst::Plugin::Authorization::CDBI::GroupToken 🫠
  • Catalyst::Plugin::CDBI::Transaction 🫠
  • Catalyst::Plugin::Config::* — the Catalyst::Plugin::Config::JSON and Catalyst::Plugin::Config::YAML modules have been replaced by their corresponding Catalyst::Plugin::ConfigLoader modules. 💀
  • Catalyst::Plugin::DefaultEnd — replaced by Catalyst::Action::RenderView 💀
  • Catalyst::Plugin::SanitizeUrl 🫠
  • Catalyst::Plugin::SanitizeUrl::PrepAction 🫠
  • Catalyst::Plugin::Session::* — 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. 💀

👑 AUTHORS 👑

The Catalyst Contributors — see Catalyst.pm for the whole squad. 💖

This library is free software, bestie. You can redistribute it and/or modify it under the same terms as Perl itself. 🫶

That’s the whole page! Sourced from the User Contributed Perl Documentation, perl v5.42.0, dated 2024-03-23. Now go slay some Catalyst modules. 💅✨

📦 where this page comes from