/ 
CatalystX-Usul-0.16.1
/ CatalystX::Usul::Response::Users

Name

CatalystX::Usul::Response::Users - The actual user object

Version

Describes v0.16.$Rev: 1 $

Synopsis

use CatalystX::Usul::Response::Users;

$user_object = CatalystX::Usul::Response::Users->new( \%params );

Description

The actual user object

Configuration and Environment

Defines a long list of attributes

Subroutines/Methods

Catalyst Authentication Store Methods

check_password

$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

for_session

$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

get

$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

get_object

$self = $self->get_object;

This method is required by the Catalyst::Authentication::Store API. Returns the self referential object

id

$username = $self->id;

This method is required by the Catalyst::Authentication::Store API. Returns the username of the user object

Public Object Methods

active

$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

has_password_expired

$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

should_warn_of_expiry

$bool = $self->should_warn_of_expiry;

Returns true if the accounts password is about to expire

when_can_change_password

$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

Diagnostics

None

Dependencies

CatalystX::Usul::Moose

Incompatibilities

There are no known incompatibilities in this module

Bugs and Limitations

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

Acknowledgements

Larry Wall - For the Perl programming language

Author

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

License and Copyright

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