CatalystX::Usul::Users::DBIC - Database user storage


CatalystX-Usul documentation  | view source Contained in the CatalystX-Usul distribution.

Index


Name

Top

CatalystX::Usul::Users::DBIC - Database user storage

Version

Top

0.3.$Revision: 619 $

Synopsis

Top

   use CatalystX::Usul::Users::DBIC;

   my $class = CatalystX::Usul::Users::DBIC;

   my $user_obj = $class->new( $app, $config );

Description

Top

User storage model for relational databases. This model makes use of DBIx::Class. It inherits from CatalystX::Usul::Model::Identity::Users and implements the required list of factory methods

Subroutines/Methods

Top

build_per_context_instance

Make copies of DBIC model references available only after the application setup is complete

get_features

Returns a hashref of features supported by this store. Can be checked using the supports method implemented in CatalystX::Usul::Model

activate_account

Searches the user model for the supplies user name and if it exists sets the active column to true

change_password

Calls update_password in CatalystX::Usul::Identity::Users with the authenticate flag set to false, thereby forcing the user to authenticate. Passes the supplied arguments through

check_password

Calls authenticate in CatalystX::Usul::Identity::Users. Returns true if the authentication succeeded, false otherwise

create

Creates a new user object on the user model. Adds the user to the list of roles appropriate to the user profile

delete

Deletes a user object from the user model

get_primary_rid

Returns undef as primary role ids are not supported by this storage backend

get_user

Returns a hash ref of fields for the request user

get_users_by_rid

Returns an empty list as primary role ids are not supported by this storage backend

is_user

Returns true if the supplied user exists, false otherwise

list

Returns a list reference of users in the database

set_password

Calls update_password in CatalystX::Usul::Identity::Users with the authenticate flag set to true, which bypasses user authentication. Passes the supplied arguments through

update

Updates columns on the user object for the supplied user

update_password

Updates the users password in the database

user_report

Generate a report from the data in the user database

validate_password

Called by check_password in the parent class. This method calls authenticate in the parent class

Diagnostics

Top

None

Configuration and Environment

Top

None

Dependencies

Top

CatalystX::Usul::Model::Identity::Users
Crypt::PasswdMD5

Incompatibilities

Top

There are no known incompatibilities in this module

Bugs and Limitations

Top

There are no known bugs in this module. Please report problems to the address below. Patches are welcome

Author

Top

Peter Flanigan, <Support at RoxSoft.co.uk>

License and Copyright

Top


CatalystX-Usul documentation  | view source Contained in the CatalystX-Usul distribution.