RT# 76181 Invoice date format can set locale from Freeside conf
[freeside.git] / rt / lib / RT / GroupMembers.pm
1 # BEGIN BPS TAGGED BLOCK {{{
2 #
3 # COPYRIGHT:
4 #
5 # This software is Copyright (c) 1996-2017 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 base 'RT::SearchBuilder';
73
74 use RT::GroupMember;
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->Join(
92         ALIAS1 => 'main', FIELD1 => 'MemberId',
93         TABLE2 => 'Principals', FIELD2 =>'id'
94     );
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
108 Limits this search object to Groups who are members of this group.
109 This is really useful when you want to have your UI separate out
110 groups from users for display purposes
111
112 =cut
113
114 sub LimitToGroups {
115     my $self = shift;
116
117     my $principals = $self->Join(
118         ALIAS1 => 'main', FIELD1 => 'MemberId',
119         TABLE2 => 'Principals', FIELD2 =>'id'
120     );
121
122     $self->Limit(       ALIAS => $principals,
123                          FIELD => 'PrincipalType',
124                          VALUE => 'Group',
125                          ENTRYAGGREGATOR => 'OR',
126                          );
127 }
128
129
130
131 =head2 LimitToMembersOfGroup PRINCIPAL_ID
132
133 Takes a Principal Id as its only argument. 
134 Limits the current search principals which are _directly_ members
135 of the group which has PRINCIPAL_ID as its principal id.
136
137 =cut
138
139 sub LimitToMembersOfGroup {
140     my $self = shift;
141     my $group = shift;
142
143     return ($self->Limit( 
144                          VALUE => $group,
145                          FIELD => 'GroupId',
146                          ENTRYAGGREGATOR => 'OR',
147                          QUOTEVALUE => 0
148                          ));
149
150 }
151
152 RT::Base->_ImportOverlays();
153
154 1;