CAS::User - Creates user objects for accessing and modifying user data.
use CAS::User; my $user = CAS::User->new(%userinfo); die "Couldn't create new user" if $user == ERROR; my $user = CAS::User->load({ID => 1234567654}); die "Couldn't load user." if $user == ERROR;
Or even better error reporting where appropriate:
if (! ref $user && $user == ERROR) { my @errors = warning_notes(); die "Failed to load user:\n\t" . join("\n\t",@errors) . "\n"; } # if error
Generate user objects for either new or existing users. The object returned is used to manage that users data, such as Password, Username, address, etc.
Currently only the CAS core Users and UserInfo tables are handled. Some handling of client user tables will be added once this is core part is functional. Set, get and validate methods are provided for the core tables, for the client tables only set and get are provided - it is the clients responsibility to validate their specific user information.
None by default.
Creates user object for a user not yet registered in the CAS system. Invoking this contructer will generate an object to use for validating new user information and entering a user in the database. When invoked it requires a Username and Password for the user, which will be validated. If those pass validation the user is registered in the database and the object is returned.
This object can now be used to validate additional user data and add it to the users record. It is highly recommended that you require the users First and Last names and any contact information you want be provided with the Username, Password, etc. and that you record all those (that validate) immediately after getting the user object back.
Please note
PARAMETERS:
Username: The Username the user will use for logging into the system. Usernames are therefor unique in the database.
Password: The Password the user will use when logging in. It is highly recommended you verify the Password before set it by having a user enter it twice and compare the two entries.
Email: An Email address for the user. This Email address will be used by the system to send Emails to the user for important system notifications, such as registration notification, systemwide administrative messages, etc. Since Email addresses are required to be unique within the system, this also discourages users from registering multiple times.
CLIENT: The client the user is registering from.
OPTIONS:
GROUP: The default initial group for the user. If not provided the default group for the client will be used, or, if that is not defined, the general default group as set in the CAS config file will be used.
Returns a user object which can be used to access and update user data. Will emit errors if fields that are expected not to be null (such as First Name) are.
ID: The ID of the user.
or
Username: The users unique Username.
Saves the current state of the user.
!! Currently does not handle client table data !!
Mark a user as diabled. Authentication will be denied.
Reset disabled flag to 'No'.
Methods in this catagory are provided to access and alter the user data. The following list describes the user attributes which these methods all work on. Altering the values of user attributes with the set_ methods does not change them in the database. Call $user->save; to make any changes permanant. Further, calling a set_ method automatically invokes the validate_ method, so there is no need to validate before setting, unless you want to just catch and handle errors yourself (to regenerate a form with failed fields highlightes for instance).
A textual key uniquely indicating one user. This value is supplied by the user when they register and will function as the name with which they log in to the system. This is usually a short login handle, such as the common first initial last name combination (squinlan), however certain sites may wish to require users to usa they're email address as a username. While the system allows the use of an email address as a username, it is up to the client to modify the user registration interface appropriately.
Once registered this field may not be altered via set_Username.
A text string containing almost any plain ASCII non-whitespace text characters. The system can optionally require however that the password contain at least one upper case, one lower case, one number and one non-alphanumeric character by setting the optional STRICT parameter to true.
Please note that the plain password string is not stored in the database. Passwords are encrypted before they are stored in the databas.
The users first name.
The users last name.
A valid email address for the user. The validation measures only examine the email to see if it looks valid. However when a new user registers an email is sent to the address provided with the from and reply-to fields set to the client administrators email address, so they should recieve bounce notifications.
A contact phone number for the user.
The first address line to be used if a physical letter or package is to be sent to the user.
The second address line to be used if a physical letter or package is to be sent to the user.
The city for the users mailing address.
The state for the users mailing address.
The country for the users mailing address.
The users zip code.
These methods make sure that the suplied information meets system requirements most of which are not enforced by the database. Such as forbidding certain characters or requiring a minimum length. If the specific data is determined to be 'invalid' then the FORBIDDEN staus code is returned.
All the set_ methods call validation before setting, so there is generally no need to call the validation yourself unless you are setting multiple fields at the same time and want them all handled in an all-or-nothing manner so want to pre-validate them.
If client id is provided data from the client table should also be loaded into the user object.
Determine what additional address fields might be advisable. And if addresses should be placed in a separate table to allow users to have multiple addresses.
Original version; created by h2xs 1.22 with options
-AXC -n CAS::User
Base adaption.
new, load, validate, get an set methods in place as well as stub new user email notification. Next come the tests.
Added tests for user object and disable/enable methods. Small additions to docs.
CAS
The home page for this project is perl-cas.org.
The mailing list for Perl CAS can be found at: http://mail.perl-cas.org/mailman/listinfo/developers_perl-cas.org
Sean Quinlan, <gilant@gmail.com>
Copyright 2004-2005 by Sean Quinlan
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
To install CAS, copy and paste the appropriate command in to your terminal.
cpanm
cpanm CAS
CPAN shell
perl -MCPAN -e shell install CAS
For more information on module installation, please visit the detailed CPAN module installation guide.