CLACO / Mango-0.01000_10 / lib / Mango / Role.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
—
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153

              
# $Id: /local/CPAN/Mango/trunk/lib/Mango/Role.pm 1959 2007-08-10T05:27:29.884596Z claco  $
package Mango::Role;
use strict;
use warnings;
BEGIN {
    use base qw/Mango::Object/;
    __PACKAGE__->mk_group_accessors('column', qw/name description/);
};
*add_user = \&add_users;
sub add_users {
    my $self = shift;
    return $self->meta->provider->add_users($self, @_);
}
*remove_user = \&remove_users;
sub remove_users {
    my $self = shift;
    return $self->meta->provider->remove_users($self, @_);
};
1;
__END__
=head1 NAME
Mango::Role - Module representing a user role
=head1 SYNOPSIS
    my $roles = $provider->search;
    while (my $role = $roles->next) {
        print $role->name, $role->description;
    };
=head1 DESCRIPTION
Mango::Role represents a user role.
=head1 METHODS
=head2 add_user
Sames as L</add_users>.
=head2 add_users
=over
=item Arguments: @users
=back
Adds a list of users to the current role.
    $role->add_users(23, $otheruser);
See L<Mango::Provider::Roles/add_users> for more details.
=head2 created
Returns the date and time in UTC the role was created as a DateTime
object.
    print $role->created;
=head2 description
=over
=item Arguments: $description
=back
Gets/sets the description of the current role.
    print $role->description;
=head2 destroy
Deletes the current role.
    $role->destroy;
=head2 id
Returns the id of the current role.
    print $role->id;
=head2 name
=over
=item Arguments: $name
=back
Gets/sets the name of the current role.
    print $role->name;
=head2 remove_users
=over
=item Arguments: @users
=back
Removes a list of users from the current role.
    $role->remove_users(23, $otheruser);
See L<Mango::Provider::Roles/remove_users> for more details.
=head2 remove_user
Sames as C<remove_users>.
=head2 update
Saves any changes made to the role back to the provider.
    $role->password('Red');
    $role->update;
Whenever L</update> is called, L</updated> is automatically set to the
current time in UTC.
=head2 updated
Returns the date and time in UTC the role was last updated as a DateTime
object.
    print $role->updated;
=head1 SEE ALSO
L<Mango::Object>, L<Mango::Provider::Roles>
=head1 AUTHOR
    Christopher H. Laco
    CPAN ID: CLACO
    claco@chrislaco.com
    http://today.icantfocus.com/blog/