Name

CatalystX::Usul::Roles::Simple - Role management file storage

Version

Describes v0.17.$Rev: 1 $

Synopsis

   use CatalystX::Usul::Roles::Simple;

   my $class = CatalystX::Usul::Roles::Simple;

   my $role_obj = $class->new( $attr );

Description

Methods to manipulate user roles in the simple user store. This class implements the methods required by it's base class CatalystX::Usul::Roles

Configuration and Environment

Defines the following list of attributes

filename

A string which defaults to roles-simple.json

path

A path to a file which contains the roles database

schema

A File::DataClass::Schema object

Subroutines/Methods

add_user_to_role

   $role_obj->add_user_to_role( $role, $user );

Adds the specified user to the specified role

create

   $role_obj->create( $role );

Creates a new role with the given name

delete

   $role_obj->delete( $role );

Deletes the specified role

remove_user_from_role

   $role_obj->remove_user_to_role( $role, $user );

Removes the specified user to the specified role

Diagnostics

None

Dependencies

CatalystX::Usul::Roles

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

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

cpanm CatalystX::Usul

perl -MCPAN -e shell
install CatalystX::Usul