CatalystX::Usul::Model::Users - Catalyst user model
0.6.$Revision: 1165 $
use CatalystX::Usul::Model::Users; my $user_obj = CatalystX::Usul::Model::Users->new( $app, $config );
Forms and actions for user maintainence
Constructor initialises these attributes
Name of the application using this identity model. Prefixes the subject line of the account activation email sent to users who create an account via the registration method
Location in the filesystem of the user reports
Location in the filesystem of used user passwords and account activation keys
An clone of the FileSystem model used by the "user_report_form" method to list the available user reports
Checks for the existence of the file created by the "register" method. If it exists it contains the username of a recently created account. The accounts active attribute is set to true, enabling the account
Calls authenticate in the domain model
Adds fields to the stash for the login screen
Authenticate the user. If another controller was wanted and the user was forced to authenticate first, redirect the session to the originally requested controller. This was stored in the session by the auto method prior to redirecting to the authentication controller which forwarded to here
Method to change the users password. Throws exceptions for field constraint failures and if the passwords entered are not the same
Adds field data to the stash for the change password screen. Allows users to change their own password
Method to create a new account or update an existing one. Throws exceptions for field constraint failures. Calls methods in the subclass to do the actual work
Deletes the selected account
Calls find_user in the domain model
Delegates the call to the domain model
Returns the primary role id for the given user. Note not all storage models support primary_role ids
Returns the list of users that share the given primary role id
Calls is_user in the domain model
Returns the domain model's profiles object
Delete the list of selected accounts
Create the self registered account. The account is created in an inactive state and a confirmation email is sent
Added the fields to the stash for the self registration screen. Users can use this screen to create their own accounts
Calls retrieve in the domain model
Sets the users password to a given value
Sets the fill attribute of the stash in response to clicking the auto fill button
Adds fields to the stash for the user management screen. Adminstrators can create new accounts or modify the details of existing ones
Creates a report of the user accounts in this realm
View either the list of available account reports or the contents of a specific report
Add fields to the stash for the security administration screen. From here administrators can reset passwords and change the list of roles to which the selected user belongs
None
There are no known incompatibilities in this module
There are no known bugs in this module. Please report problems to the address below. Patches are welcome
Peter Flanigan, <Support at RoxSoft.co.uk>
<Support at RoxSoft.co.uk>
Larry Wall - For the Perl programming language
Copyright (c) 2011 Peter Flanigan. All rights reserved
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic
This program is distributed in the hope that it will be useful, but WITHOUT WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE
To install CatalystX::Usul, copy and paste the appropriate command in to your terminal.
cpanm
cpanm CatalystX::Usul
CPAN shell
perl -MCPAN -e shell install CatalystX::Usul
For more information on module installation, please visit the detailed CPAN module installation guide.