CatalystX::Usul::Response::Users - The actual user object
Describes v0.16.$Rev: 1 $
use CatalystX::Usul::Response::Users; $user_object = CatalystX::Usul::Response::Users->new( \%params );
The actual user object
Defines a long list of attributes
$bool = $self->check_password( $password );
This method is required by the Catalyst::Authentication::Store API. It calls the factory method in the subclass to check that the supplied password is the correct one
$self_for_session = $self->for_session;
This method is required by the Catalyst::Authentication::Store API. Returns the self referential object with some attribute values removed from the hash
$attribute_value = $self->get( $attribute_name );
This method is required by the Catalyst::Authentication::Store API. Field accessor returns undef if the field does not exist, otherwise returns the value of the required field
$self = $self->get_object;
This method is required by the Catalyst::Authentication::Store API. Returns the self referential object
$username = $self->id;
This method is required by the Catalyst::Authentication::Store API. Returns the username of the user object
$bool = $self->active;
Returns true if the account is active. Can be inactive because of active field in the user account data being set to false, or the account can be inactive due to password expiration
$bool = $self->has_password_expired;
Returns true if this user object's password has expired. For the expiry period the password on the account can still be changed
$bool = $self->should_warn_of_expiry;
Returns true if the accounts password is about to expire
$days = $self->when_can_change_password;
Returns the number of days before the password can be changed. Returns 0 if the password can be changed now
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
Larry Wall - For the Perl programming language
Peter Flanigan, <Support at RoxSoft.co.uk>
<Support at RoxSoft.co.uk>
Copyright (c) 2014 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.