Name

CatalystX::Usul::Roles::DBIC - Role management database storage

Version

Describes v0.17.$Rev: 1 $

Synopsis

   use CatalystX::Usul::Roles::DBIC;

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

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

Description

Methods to manipulate the roles and user_roles table in a database using DBIx::Class. This class implements the methods required by it's base class

Configuration and Environment

Defines the following attributes;

dbic_role_model

The schema object for the roles table

dbic_user_roles_model

The schema object form the user_roles join table

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

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