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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
# BEGIN BPS TAGGED BLOCK {{{
#
# COPYRIGHT:
#
# This software is Copyright (c) 1996-2022 Best Practical Solutions, LLC
# <sales@bestpractical.com>
#
# (Except where explicitly superseded by other copyright notices)
#
#
# LICENSE:
#
# This work is made available to you under the terms of Version 2 of
# the GNU General Public License. A copy of that license should have
# been provided with this software, but in any event can be snarfed
# from www.gnu.org.
#
# This work is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301 or visit their web page on the internet at
# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
#
#
# CONTRIBUTION SUBMISSION POLICY:
#
# (The following paragraph is not intended to limit the rights granted
# to you to modify and distribute this software under the terms of
# the GNU General Public License and is only of importance to you if
# you choose to contribute your changes and enhancements to the
# community by submitting them to Best Practical Solutions, LLC.)
#
# By intentionally submitting any modifications, corrections or
# derivatives to this work, or any other work intended for use with
# Request Tracker, to Best Practical Solutions, LLC, you confirm that
# you are the copyright holder for those contributions and you grant
# Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable,
# royalty-free, perpetual, license to use, copy, create derivative
# works based on those contributions, and sublicense and distribute
# those contributions and any derivatives thereof.
#
# END BPS TAGGED BLOCK }}}
use strict;
use warnings;
package RT::CustomRoles;
use base 'RT::SearchBuilder';
use RT::CustomRole;
=head1 NAME
RT::CustomRoles - collection of RT::CustomRole records
=head1 DESCRIPTION
Collection of L<RT::CustomRole> records. Inherits methods from L<RT::SearchBuilder>.
=head1 METHODS
=cut
=head2 Table
Returns name of the table where records are stored.
=cut
sub Table { 'CustomRoles'}
sub _Init {
my $self = shift;
$self->{'with_disabled_column'} = 1;
return ( $self->SUPER::_Init(@_) );
}
sub _ObjectCustomRoleAlias {
my $self = shift;
return RT::ObjectCustomRoles->new( $self->CurrentUser )
->JoinTargetToThis( $self => @_ );
}
=head2 RegisterRoles
This declares all (enabled) custom roles to the L<RT::Record::Role::Roles>
subsystem, suitable for system startup.
=cut
sub RegisterRoles {
my $class = shift;
for my $type ( keys %RT::Record::Role::Roles::ROLES ) {
%{ $RT::Record::Role::Roles::ROLES{$type} } = map { $_ => $RT::Record::Role::Roles::ROLES{$type}{$_} }
grep { !/^RT::CustomRole-/ } keys %{$RT::Record::Role::Roles::ROLES{$type}};
}
my $roles = $class->new(RT->SystemUser);
$roles->UnLimit;
while (my $role = $roles->Next) {
$role->_RegisterAsRole;
}
}
=head2 LimitToObjectId
Takes an ObjectId and limits the collection to custom roles applied to said object.
When called multiple times the ObjectId limits are joined with OR.
=cut
sub LimitToObjectId {
my $self = shift;
my $id = shift;
$self->Limit(
ALIAS => $self->_ObjectCustomRoleAlias,
FIELD => 'ObjectId',
OPERATOR => '=',
VALUE => $id,
ENTRYAGGREGATOR => 'OR'
);
}
=head2 LimitToSingleValue
Limits the list of custom roles to only those that take a single value.
=cut
sub LimitToSingleValue {
my $self = shift;
$self->Limit(
FIELD => 'MaxValues',
OPERATOR => '=',
VALUE => 1,
);
}
=head2 LimitToMultipleValue
Limits the list of custom roles to only those that take multiple values.
=cut
sub LimitToMultipleValue {
my $self = shift;
$self->Limit(
FIELD => 'MaxValues',
OPERATOR => '=',
VALUE => 0,
);
}
=head2 LimitToLookupType
Takes LookupType and limits collection.
=cut
sub LimitToLookupType {
my $self = shift;
my $lookup = shift;
$self->Limit( FIELD => 'LookupType', VALUE => "$lookup" );
}
=head2 ApplySortOrder
Sort custom roles according to the order provided by the object custom roles.
=cut
sub ApplySortOrder {
my $self = shift;
my $order = shift || 'ASC';
$self->OrderByCols( {
ALIAS => $self->_ObjectCustomRoleAlias,
FIELD => 'SortOrder',
ORDER => $order,
} );
}
=head2 LimitToNotAdded
Takes either list of object ids or nothing. Limits collection
to custom roles to listed objects or any corespondingly.
=cut
sub LimitToNotAdded {
my $self = shift;
return RT::ObjectCustomRoles->new( $self->CurrentUser )->LimitTargetToNotAdded( $self => @_ );
}
=head2 LimitToAdded
Limits collection to custom roles to listed objects or any corespondingly.
=cut
sub LimitToAdded {
my $self = shift;
return RT::ObjectCustomRoles->new( $self->CurrentUser )->LimitTargetToAdded( $self => @_ );
}
RT::Base->_ImportOverlays();
1;
|