Initial commit 4.0.5-3
[usit-rt.git] / lib / RT / GroupMembers.pm
1 # BEGIN BPS TAGGED BLOCK {{{
2 #
3 # COPYRIGHT:
4 #
5 # This software is Copyright (c) 1996-2012 Best Practical Solutions, LLC
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::GroupMembers - a collection of RT::GroupMember objects
52
53 =head1 SYNOPSIS
54
55   use RT::GroupMembers;
56
57 =head1 DESCRIPTION
58
59
60 =head1 METHODS
61
62
63
64 =cut
65
66
67 package RT::GroupMembers;
68
69 use strict;
70 use warnings;
71
72 use RT::GroupMember;
73
74 use base 'RT::SearchBuilder';
75
76 sub Table { 'GroupMembers'}
77
78
79
80 =head2 LimitToUsers
81
82 Limits this search object to users who are members of this group.
83 This is really useful when you want to have your UI separate out
84 groups from users for display purposes
85
86 =cut
87
88 sub LimitToUsers {
89     my $self = shift;
90
91     my $principals = $self->NewAlias('Principals');
92     $self->Join( ALIAS1 => 'main', FIELD1 => 'MemberId',
93                  ALIAS2 => $principals, FIELD2 =>'id');
94
95     $self->Limit(       ALIAS => $principals,
96                          FIELD => 'PrincipalType',
97                          VALUE => 'User',
98                          ENTRYAGGREGATOR => 'OR',
99                          );
100 }
101
102
103
104
105 =head2 LimitToGroups
106
107 Limits this search object to Groups who are members of this group.
108 This is really useful when you want to have your UI separate out
109 groups from users for display purposes
110
111 =cut
112
113 sub LimitToGroups {
114     my $self = shift;
115
116     my $principals = $self->NewAlias('Principals');
117     $self->Join( ALIAS1 => 'main', FIELD1 => 'MemberId',
118                  ALIAS2 => $principals, FIELD2 =>'id');
119
120     $self->Limit(       ALIAS => $principals,
121                          FIELD => 'PrincipalType',
122                          VALUE => 'Group',
123                          ENTRYAGGREGATOR => 'OR',
124                          );
125 }
126
127
128
129 =head2 LimitToMembersOfGroup PRINCIPAL_ID
130
131 Takes a Principal Id as its only argument. 
132 Limits the current search principals which are _directly_ members
133 of the group which has PRINCIPAL_ID as its principal id.
134
135 =cut
136
137 sub LimitToMembersOfGroup {
138     my $self = shift;
139     my $group = shift;
140
141     return ($self->Limit( 
142                          VALUE => $group,
143                          FIELD => 'GroupId',
144                          ENTRYAGGREGATOR => 'OR',
145                                      QUOTEVALUE => 0
146                          ));
147
148 }
149
150
151
152 =head2 NewItem
153
154 Returns an empty new RT::GroupMember item
155
156 =cut
157
158 sub NewItem {
159     my $self = shift;
160     return(RT::GroupMember->new($self->CurrentUser));
161 }
162 RT::Base->_ImportOverlays();
163
164 1;