CatalystX::Usul::Model::Roles - Manage the roles and their members
Describes v0.16.$Rev: 1 $
package YourApp::Model::Roles; use CatalystX::Usul::Moose; extends q(CatalystX::Usul::Model::Roles);
Manage the roles and their members
Defines the following list of attributes
A required non empty simple string. Passed by "build_per_context_instance" to the Catalyst model method
Sets our domain model to that of our user model's, domain model's roles object
$role_obj->add_roles_to_user( $args );
Adds the user to one or more roles. The user is passed in $args->{user} and $args->{field} is the field to extract from the request object. Calls f_add_user_to_role in the factory subclass to add one user to one role. A suitable message from the stash $s is added to the result div upon success
$args->{user}
$args->{field}
f_add_user_to_role
$s
$role_obj->add_users_to_role( $args );
Adds one or more users to the specified role. The role is passed in $args->{role} and $args->{field} is the field to extract from the request object. Calls f_add_user_to_role in the factory subclass to add one user to one role. A suitable message from the stash $s is added to the result div upon success
$args->{role}
$role_obj->create;
Creates a new role. The name field from the request object is passed to f_create in the factory subclass. A suitable message from the stash $s is added to the result div upon success
f_create
$role_obj->delete;
Deletes an existing role. The role field from the request object is passed to the f_delete method in the factory subclass. A suitable message from the stash $s is added to the result div
f_delete
@members = $role_obj->get_member_list( $role );
Returns the list of members of a given role. Exposes method in the domain model
@roles = $role_obj->get_roles( $user, $rid );
Returns the list of roles that the given user is a member of. Exposes method in the domain model
$bool = $role_obj->is_role( $role );
Returns true if $role exists, false otherwise. Exposes method in the domain model
$role
$role_obj->remove_roles_from_user( $args );
Removes a user from one or more roles
$role_obj->remove_users_from_role( $args );
Removes one or more users from a role
$role_obj->role_form;
Adds data to the stash which displays the role management screen
$role_obj->update_roles;
Called as an action from the the management screen. This method determines if roles have been added and/or removed from the selected user and calls "add_roles_to_user" and/or "remove_roles_from_user" as appropriate
$role_obj->update_users;
Called as an action from the the management screen. This method determines if users have been added and/or removed from the selected role and calls "add_users_to_role" and/or "remove_users_from_role" as appropriate
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.