catalyst::plugin::cache::store(3pm) [debian man page]

Catalyst::Plugin::Cache::Store(3pm)			User Contributed Perl Documentation		       Catalyst::Plugin::Cache::Store(3pm)

NAME

       Catalyst::Plugin::Cache::Store - how to write a Cache store plugin.

SYNOPSIS

	   package Catalyst::Plugin::Cache::Store::Frobnicator;

	   sub setup_frobnicator_cache_backend {
	       my ( $app, $name, $config ) = @_;

	       ....

	       $app->register_cache_backend( $name => $cache_object );
	   }

DESCRIPTION

       In order to write a cache store plugin, all you need is to implement a method following the naming convention:

	   setup_<<lower case store name>>_cache_backend {

	   }

       For example "setup_fastmmap_cache_backend" for Catalyst::Plugin::Cache::Store::FastMmap.

       and call "register_cache_backend" from within that.

       The method will get the backend name and configuration as it's first and second arguments.

       All invokation of the setup methods will be automatic, based on the configuration. However, the plugin must be loaded by the user.

       Note that store plugins are only necessary if some configuration defaults that are catalyst specific need to be provided.

       For most cases simply using a cache class instead of a plugin is sufficient.

perl v5.14.2							    2012-03-13				       Catalyst::Plugin::Cache::Store(3pm)

Catalyst::Authentication::Store::Minimal(3pm)		User Contributed Perl Documentation	     Catalyst::Authentication::Store::Minimal(3pm)

NAME

       Catalyst::Authentication::Store::Minimal - Minimal authentication store

SYNOPSIS

	   # you probably just want Store::Minimal under most cases,
	   # but if you insist you can instantiate your own store:

	   use Catalyst::Authentication::Store::Minimal;

	   use Catalyst qw/
	       Authentication
	   /;

	   __PACKAGE__->config( 'Plugin::Authentication' =>
			   {
			       default_realm => 'members',
			       realms => {
				   members => {
				       credential => {
					   class => 'Password',
					   password_field => 'password',
					   password_type => 'clear'
				       },
				       store => {
					   class => 'Minimal',
					   users => {
					       bob => {
						   password => "s00p3r",
						   editor => 'yes',
						   roles => [qw/edit delete/],
					       },
					       william => {
						   password => "s3cr3t",
						   roles => [qw/comment/],
					       }
					   }
				       }
				   }
			       }
			   }
	   );

DESCRIPTION

       This authentication store lets you create a very quick and dirty user database in your application's config hash.

       You will need to include the Authentication plugin, and at least one Credential plugin to use this Store. Credential::Password is
       reccommended.

       It's purpose is mainly for testing, and it should probably be replaced by a more "serious" store for production.

       The hash in the config, as well as the user objects/hashes are freely mutable at runtime.

CONFIGURATION

       class
	   The classname used for the store. This is part of Catalyst::Plugin::Authentication and is the method by which
	   Catalyst::Authentication::Store::Minimal is loaded as the user store. For this module to be used, this must be set to 'Minimal'.

       users
	   This is a simple hash of users, the keys are the usenames, and the values are hashrefs containing a password key/value pair, and
	   optionally, a roles/list of role-names pair. If using roles, you will also need to add the Authorization::Roles plugin.

	   See the SYNOPSIS for an example.

METHODS

       There are no publicly exported routines in the Minimal store (or indeed in most authentication stores)  However, below is a description of
       the routines required by Catalyst::Plugin::Authentication for all authentication stores.

   new( $config, $app, $realm )
       Constructs a new store object, which uses the user element of the supplied config hash ref as it's backing structure.

   find_user( $authinfo, $c )
       Keys the hash by the 'id' or 'username' element in the authinfo hash and returns the user.

       ... documentation fairy stopped here. ...

       If the return value is unblessed it will be blessed as Catalyst::Authentication::User::Hash.

   from_session( $id )
       Delegates to "get_user".

   user_supports( )
       Chooses a random user from the hash and delegates to it.

   get_user( )
       Deprecated

   setup( )
perl v5.14.2							    2012-04-14			     Catalyst::Authentication::Store::Minimal(3pm)