Catalyst::Authentication::Store::Minimal man page on Pidora

Man page or keyword search:  
man Server   31170 pages
apropos Keyword Search (all sections)
Output format
Pidora logo
[printable version]

Catalyst::AuthenticatiUserSContribuCatalyst::Authentication::Store::Minimal(3)

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.1			  2Catalyst::Authentication::Store::Minimal(3)
[top]

List of man pages available for Pidora

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net