1Catalyst::AuthenticatioUns:e:rCSatCtooarnlety:rs:itDb:Bu:ItAxeu:dt:hCPelenartslisc:Da:otUcisuoemnre:(n:3tS)attoiroen::DBIx::Class::User(3)
2
3
4

NAME

6       Catalyst::Authentication::Store::DBIx::Class::User - The backing user
7       class for the Catalyst::Authentication::Store::DBIx::Class storage
8       module.
9

VERSION

11       This documentation refers to version 0.1506.
12

SYNOPSIS

14       Internal - not used directly, please see
15       Catalyst::Authentication::Store::DBIx::Class for details on how to use
16       this module. If you need more information than is present there, read
17       the source.
18

DESCRIPTION

20       The Catalyst::Authentication::Store::DBIx::Class::User class implements
21       user storage connected to an underlying DBIx::Class schema object.
22

SUBROUTINES / METHODS

24   new
25       Constructor.
26
27   load ( $authinfo, $c )
28       Retrieves a user from storage using the information provided in
29       $authinfo.
30
31   supported_features
32       Indicates the features supported by this class.  These are currently
33       Roles and Session.
34
35   roles
36       Returns an array of roles associated with this user, if roles are
37       configured for this user class.
38
39   for_session
40       Returns a serialized user for storage in the session.
41
42   from_session
43       Revives a serialized user from storage in the session.
44
45   get ( $fieldname )
46       Returns the value of $fieldname for the user in question.  Roughly
47       translates to a call to the DBIx::Class::Row's get_column( $fieldname )
48       routine.
49
50   get_object
51       Retrieves the DBIx::Class object that corresponds to this user
52
53   obj (method)
54       Synonym for get_object
55
56   auto_create
57       This is called when the auto_create_user option is turned on in
58       Catalyst::Plugin::Authentication and a user matching the authinfo
59       provided is not found.  By default, this will call the "auto_create()"
60       method of the resultset associated with this object. It is up to you to
61       implement that method.
62
63   auto_update
64       This is called when the auto_update_user option is turned on in
65       Catalyst::Plugin::Authentication. Note that by default the DBIx::Class
66       store uses every field in the authinfo hash to match the user. This
67       means any information you provide with the intent to update must be
68       ignored during the user search process. Otherwise the information will
69       most likely cause the user record to not be found. To ignore fields in
70       the search process, you have to add the fields you wish to update to
71       the 'ignore_fields_in_find' authinfo element.  Alternately, you can use
72       one of the advanced row retrieval methods (searchargs or resultset).
73
74       By default, auto_update will call the "auto_update()" method of the
75       DBIx::Class::Row object associated with the user. It is up to you to
76       implement that method (probably in your schema file)
77
78   AUTOLOAD
79       Delegates method calls to the underlying user row.
80
81   can
82       Delegates handling of the "can" method to the underlying user row.
83

BUGS AND LIMITATIONS

85       None known currently, please email the author if you find any.
86

AUTHOR

88       Jason Kuri (jayk@cpan.org)
89

CONTRIBUTORS

91       Matt S Trout (mst) <mst@shadowcat.co.uk>
92
93       (fixes wrt can/AUTOLOAD sponsored by <http://reask.com/>)
94

LICENSE

96       Copyright (c) 2007-2010 the aforementioned authors. All rights
97       reserved. This program is free software; you can redistribute it and/or
98       modify it under the same terms as Perl itself.
99
100
101
102perl v5.34.0             Catalyst:2:0A2u1t-h0e7n-t2i2cation::Store::DBIx::Class::User(3)