1Catalyst::AuthenticatioUns:e:rUsCeorn(t3r)ibuted Perl DoCcautmaelnytsatt:i:oAnuthentication::User(3)
2
3
4

NAME

6       Catalyst::Authentication::User - Base class for user objects.
7

SYNOPSIS

9           package MyStore::User;
10           use base qw/Catalyst::Authentication::User/;
11

DESCRIPTION

13       This is the base class for authentication user objects.
14
15       THIS IS NOT A COMPLETE CLASS! it is intended to provide base
16       functionality only.
17
18       It provides the base methods listed below, and any additional methods
19       are proxied onto the user object fetched from the underlieing store.
20

NOTES TO STORE IMPLEMENTORS

22       Please read the comments in the source code of this class to work out
23       which methods you should override.
24

METHODS

26   id( )
27       A unique ID by which a user can be retrieved from the store.
28
29   store( )
30       Should return a class name that can be used to refetch the user using
31       it's ID.
32
33   supports( )
34       An introspection method used to determine what features a user object
35       has, to support credential and authorization plugins.
36
37   get( $field )
38       Returns the value for the $field provided.
39
40   get_object( )
41       Returns the underlying object storing the user data.  The return value
42       of this method will vary depending on the storage module used.
43
44   obj( )
45       Shorthand for get_object( )
46
47   AUTOLOAD
48       Delegates any unknown methods onto the user object returned by ->obj
49
50
51
52perl v5.28.1                      2012-06-30 Catalyst::Authentication::User(3)
Impressum