1 # BEGIN BPS TAGGED BLOCK {{{
5 # This software is Copyright (c) 1996-2011 Best Practical Solutions, LLC
6 # <sales@bestpractical.com>
8 # (Except where explicitly superseded by other copyright notices)
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
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.
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.
30 # CONTRIBUTION SUBMISSION POLICY:
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.)
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.
47 # END BPS TAGGED BLOCK }}}
51 RT::CachedGroupMembers - a collection of RT::GroupMember objects
55 use RT::CachedGroupMembers;
67 package RT::CachedGroupMembers;
70 no warnings qw(redefine);
76 Limits this search object to users who are members of this group
77 This is really useful when you want to have your UI separate out
78 groups from users for display purposes
85 my $principals = $self->NewAlias('Principals');
86 $self->Join( ALIAS1 => 'main', FIELD1 => 'MemberId',
87 ALIAS2 => $principals, FIELD2 =>'id');
89 $self->Limit( ALIAS => $principals,
90 FIELD => 'PrincipalType',
92 ENTRYAGGREGATOR => 'OR',
103 Limits this search object to Groups who are members of this group
104 This is really useful when you want to have your UI separate out
105 groups from users for display purposes
112 my $principals = $self->NewAlias('Principals');
113 $self->Join( ALIAS1 => 'main', FIELD1 => 'MemberId',
114 ALIAS2 => $principals, FIELD2 =>'id');
116 $self->Limit( ALIAS => $principals,
117 FIELD => 'PrincipalType',
119 ENTRYAGGREGATOR => 'OR',
125 # {{{ sub LimitToMembersOfGroup
127 =head2 LimitToMembersOfGroup PRINCIPAL_ID
129 Takes a Principal Id as its only argument.
130 Limits the current search principals which are _directly_ members
131 of the group which has PRINCIPAL_ID as its principal id.
135 sub LimitToMembersOfGroup {
139 return ($self->Limit(
142 ENTRYAGGREGATOR => 'OR',
148 # {{{ sub LimitToGroupsWithMember
150 =head2 LimitToGroupsWithMember PRINCIPAL_ID
152 Takes a Principal Id as its only argument.
153 Limits the current search to groups which contain PRINCIPAL_ID as a member or submember.
154 This function gets used by GroupMember->Create to populate subgroups
158 sub LimitToGroupsWithMember {
164 return ($self->Limit(
165 VALUE => $member || '0',
167 ENTRYAGGREGATOR => 'OR',