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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
package FS::access_group;
use base qw( FS::m2m_Common FS::m2name_Common FS::Record );
use strict;
use Carp qw( croak );
use FS::Record qw( qsearch qsearchs );
use FS::access_right;
=head1 NAME
FS::access_group - Object methods for access_group records
=head1 SYNOPSIS
use FS::access_group;
$record = new FS::access_group \%hash;
$record = new FS::access_group { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
=head1 DESCRIPTION
An FS::access_group object represents an access group. FS::access_group inherits from
FS::Record. The following fields are currently supported:
=over 4
=item groupnum - primary key
=item groupname - Access group name
=back
=head1 METHODS
=over 4
=item new HASHREF
Creates a new access group. To add the access group to the database, see L<"insert">.
Note that this stores the hash reference, not a distinct copy of the hash it
points to. You can ask the object for a copy with the I<hash> method.
=cut
# the new method can be inherited from FS::Record, if a table method is defined
sub table { 'access_group'; }
=item insert
Adds this record to the database. If there is an error, returns the error,
otherwise returns false.
=cut
# the insert method can be inherited from FS::Record
=item delete
Delete this record from the database.
=cut
# the delete method can be inherited from FS::Record
=item replace OLD_RECORD
Replaces the OLD_RECORD with this one in the database. If there is an error,
returns the error, otherwise returns false.
=cut
# the replace method can be inherited from FS::Record
=item check
Checks all fields to make sure this is a valid access group. If there is
an error, returns the error, otherwise returns false. Called by the insert
and replace methods.
=cut
# the check method should currently be supplied - FS::Record contains some
# data checking routines
sub check {
my $self = shift;
my $error =
$self->ut_numbern('groupnum')
|| $self->ut_text('groupname')
;
return $error if $error;
$self->SUPER::check;
}
=item access_groupagent
Returns all associated FS::access_groupagent records.
=item access_rights
Returns all associated FS::access_right records.
=cut
sub access_rights {
my $self = shift;
qsearch('access_right', { 'righttype' => 'FS::access_group',
'rightobjnum' => $self->groupnum
}
);
}
=item access_right RIGHTNAME
Returns the specified FS::access_right record. Can be used as a boolean, to
test if this group has the given RIGHTNAME.
=cut
sub access_right {
my( $self, $name ) = @_;
qsearchs('access_right', { 'righttype' => 'FS::access_group',
'rightobjnum' => $self->groupnum,
'rightname' => $name,
}
);
}
=item grant_access_right RIGHTNAME
Grant the specified specified FS::access_right record to this group.
Return the FS::access_right record.
=cut
sub grant_access_right {
my ( $self, $rightname ) = @_;
croak "grant_access_right() requires \$rightname"
unless $rightname;
my $access_right = $self->access_right( $rightname );
return $access_right if $access_right;
$access_right = FS::access_right->new({
righttype => 'FS::access_group',
rightobjnum => $self->groupnum,
rightname => $rightname,
});
if ( my $error = $access_right->insert ) {
die "grant_access_right() error: $error";
}
$access_right;
}
=item revoke_access_right RIGHTNAME
Revoke the specified FS::access_right record from this group.
=cut
sub revoke_access_right {
my ( $self, $rightname ) = @_;
croak "revoke_access_right() requires \$rightname"
unless $rightname;
my $access_right = $self->access_right( $rightname )
or return;
if ( my $error = $access_right->delete ) {
die "revoke_access_right() error: $error";
}
}
=back
=head1 BUGS
=head1 SEE ALSO
L<FS::Record>, schema.html from the base documentation.
=cut
1;
|
