CatalystX::Usul::Users::Simple - User data store in local files
Describes v0.16.$Rev: 1 $
use CatalystX::Usul::Users::Simple; my $class = CatalystX::Usul::Users::Simple; my $user = $class->new( $attr );
Stores user account information in a JSON file in the control directory
Defined the following attributes
A hash ref which maps the field names used by the user model onto the field names used by the data store
The name of the file containing the user accounts. A string which defaults to users-simple.json
A hash ref which details the features supported by this user data store
A path to a file that contains the user accounts
An instance of File::DataClass::Schema using the JSON storage class
Searches the user store for the supplied user name and if it exists sets the active column to true
Returns a CatalystX::Usul::Response::User object for the specified user or throws an exception if the user does not exist
Changes the users password
Checks the users password
Create a new user account, populate the home directory and create a mail alias for the users email address to the new account
Delete the users mail alias and then delete the account
Returns the users primary role (group) id from the user account file
Returns a hashref containing the data fields for the requested user. Maps the field name specific to the store to those used by the user model
Returns the list of users the share the given primary role (group) id
Returns true if the user exists, false otherwise
Returns the list of usernames matching the given pattern
Sets the users password to a given value
Updates the user account information
Updates the users password in the database
Creates a report about the user accounts in this store
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>
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.