Putting 4.2.0 on top of 4.0.17
[usit-rt.git] / lib / RT / CachedGroupMembers.pm
CommitLineData
84fb5b46
MKG
1# BEGIN BPS TAGGED BLOCK {{{
2#
3# COPYRIGHT:
4#
403d7b0b 5# This software is Copyright (c) 1996-2013 Best Practical Solutions, LLC
84fb5b46
MKG
6# <sales@bestpractical.com>
7#
8# (Except where explicitly superseded by other copyright notices)
9#
10#
11# LICENSE:
12#
13# This work is made available to you under the terms of Version 2 of
14# the GNU General Public License. A copy of that license should have
15# been provided with this software, but in any event can be snarfed
16# from www.gnu.org.
17#
18# This work is distributed in the hope that it will be useful, but
19# WITHOUT ANY WARRANTY; without even the implied warranty of
20# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21# General Public License for more details.
22#
23# You should have received a copy of the GNU General Public License
24# along with this program; if not, write to the Free Software
25# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
26# 02110-1301 or visit their web page on the internet at
27# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
28#
29#
30# CONTRIBUTION SUBMISSION POLICY:
31#
32# (The following paragraph is not intended to limit the rights granted
33# to you to modify and distribute this software under the terms of
34# the GNU General Public License and is only of importance to you if
35# you choose to contribute your changes and enhancements to the
36# community by submitting them to Best Practical Solutions, LLC.)
37#
38# By intentionally submitting any modifications, corrections or
39# derivatives to this work, or any other work intended for use with
40# Request Tracker, to Best Practical Solutions, LLC, you confirm that
41# you are the copyright holder for those contributions and you grant
42# Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable,
43# royalty-free, perpetual, license to use, copy, create derivative
44# works based on those contributions, and sublicense and distribute
45# those contributions and any derivatives thereof.
46#
47# END BPS TAGGED BLOCK }}}
48
49=head1 NAME
50
51 RT::CachedGroupMembers - a collection of RT::GroupMember objects
52
53=head1 SYNOPSIS
54
55 use RT::CachedGroupMembers;
56
57=head1 DESCRIPTION
58
59
60=head1 METHODS
61
62
63
64=cut
65
66
67package RT::CachedGroupMembers;
68
69use strict;
70use warnings;
71
af59614d 72use base 'RT::SearchBuilder';
84fb5b46
MKG
73
74use RT::CachedGroupMember;
75
84fb5b46
MKG
76sub Table { 'CachedGroupMembers'}
77
78# {{{ LimitToUsers
79
80=head2 LimitToUsers
81
82Limits this search object to users who are members of this group
83This is really useful when you want to have your UI separate out
84groups from users for display purposes
85
86=cut
87
88sub LimitToUsers {
89 my $self = shift;
90
af59614d
MKG
91 my $principals = $self->Join(
92 ALIAS1 => 'main', FIELD1 => 'MemberId',
93 TABLE2 => 'Principals', FIELD2 =>'id'
94 );
84fb5b46
MKG
95
96 $self->Limit( ALIAS => $principals,
97 FIELD => 'PrincipalType',
98 VALUE => 'User',
99 ENTRYAGGREGATOR => 'OR',
100 );
101}
102
103
104
105
106=head2 LimitToGroups
107
108Limits this search object to Groups who are members of this group
109This is really useful when you want to have your UI separate out
110groups from users for display purposes
111
112=cut
113
114sub LimitToGroups {
115 my $self = shift;
116
af59614d
MKG
117 my $principals = $self->Join(
118 ALIAS1 => 'main', FIELD1 => 'MemberId',
119 TABLE2 => 'Principals', FIELD2 =>'id'
120 );
121
84fb5b46
MKG
122
123 $self->Limit( ALIAS => $principals,
124 FIELD => 'PrincipalType',
125 VALUE => 'Group',
126 ENTRYAGGREGATOR => 'OR',
127 );
128}
129
130
131
132=head2 LimitToMembersOfGroup PRINCIPAL_ID
133
134Takes a Principal Id as its only argument.
135Limits the current search principals which are _directly_ members
136of the group which has PRINCIPAL_ID as its principal id.
137
138=cut
139
140sub LimitToMembersOfGroup {
141 my $self = shift;
142 my $group = shift;
143
144 return ($self->Limit(
145 VALUE => $group,
146 FIELD => 'GroupId',
147 ENTRYAGGREGATOR => 'OR',
148 ));
149
150}
151
152
153=head2 LimitToGroupsWithMember PRINCIPAL_ID
154
155Takes a Principal Id as its only argument.
156Limits the current search to groups which contain PRINCIPAL_ID as a member or submember.
157This function gets used by GroupMember->Create to populate subgroups
158
159=cut
160
161sub LimitToGroupsWithMember {
162 my $self = shift;
163 my $member = shift;
164
165
166
167 return ($self->Limit(
168 VALUE => $member || '0',
169 FIELD => 'MemberId',
170 ENTRYAGGREGATOR => 'OR',
af59614d 171 QUOTEVALUE => 0
84fb5b46
MKG
172 ));
173
174}
175# }}}
176
177
84fb5b46
MKG
178RT::Base->_ImportOverlays();
179
1801;