import of rt 3.0.4

[freeside.git] / rt / lib / RT / CachedGroupMembers_Overlay.pm

diff --git a/rt/lib/RT/CachedGroupMembers_Overlay.pm b/rt/lib/RT/CachedGroupMembers_Overlay.pm
new file mode 100644 (file)
index 0000000..fd0fd90
--- /dev/null
+++ b/rt/lib/RT/CachedGroupMembers_Overlay.pm
@@ -0,0 +1,148 @@
+# BEGIN LICENSE BLOCK
+# 
+# Copyright (c) 1996-2003 Jesse Vincent <jesse@bestpractical.com>
+# 
+# (Except where explictly superceded by other copyright notices)
+# 
+# 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.
+# 
+# Unless otherwise specified, all modifications, corrections or
+# extensions to this work which alter its source code become the
+# property of Best Practical Solutions, LLC when submitted for
+# inclusion in the work.
+# 
+# 
+# END LICENSE BLOCK
+=head1 NAME
+
+  RT::CachedGroupMembers - a collection of RT::GroupMember objects
+
+=head1 SYNOPSIS
+
+  use RT::CachedGroupMembers;
+
+=head1 DESCRIPTION
+
+
+=head1 METHODS
+
+
+=begin testing
+
+ok (require RT::CachedGroupMembers);
+
+=end testing
+
+=cut
+
+use strict;
+no warnings qw(redefine);
+
+# {{{ LimitToUsers
+
+=head2 LimitToUsers
+
+Limits this search object to users who are members of this group
+This is really useful when you want to haave your UI seperate out
+groups from users for display purposes
+
+=cut
+
+sub LimitToUsers {
+    my $self = shift;
+
+    my $principals = $self->NewAlias('Principals');
+    $self->Join( ALIAS1 => 'main', FIELD1 => 'MemberId',
+                 ALIAS2 => $principals, FIELD2 =>'id');
+
+    $self->Limit(       ALIAS => $principals,
+                         FIELD => 'PrincipalType',
+                         VALUE => 'User',
+                         ENTRYAGGREGATOR => 'OR',
+                         );
+}
+
+# }}}
+
+
+# {{{ LimitToGroups
+
+=head2 LimitToGroups
+
+Limits this search object to Groups who are members of this group
+This is really useful when you want to haave your UI seperate out
+groups from users for display purposes
+
+=cut
+
+sub LimitToGroups {
+    my $self = shift;
+
+    my $principals = $self->NewAlias('Principals');
+    $self->Join( ALIAS1 => 'main', FIELD1 => 'MemberId',
+                 ALIAS2 => $principals, FIELD2 =>'id');
+
+    $self->Limit(       ALIAS => $principals,
+                         FIELD => 'PrincipalType',
+                         VALUE => 'Group',
+                         ENTRYAGGREGATOR => 'OR',
+                         );
+}
+
+# }}}
+
+# {{{ sub LimitToMembersOfGroup
+
+=head2 LimitToMembersOfGroup PRINCIPAL_ID
+
+Takes a Principal Id as its only argument. 
+Limits the current search principals which are _directly_ members
+of the group which has PRINCIPAL_ID as its principal id.
+
+=cut
+
+sub LimitToMembersOfGroup {
+    my $self = shift;
+    my $group = shift;
+
+    return ($self->Limit( 
+                         VALUE => $group,
+                         FIELD => 'GroupId',
+                         ENTRYAGGREGATOR => 'OR',
+                         ));
+
+}
+# }}}
+
+# {{{ sub LimitToGroupsWithMember
+
+=head2 LimitToGroupsWithMember PRINCIPAL_ID
+
+Takes a Principal Id as its only argument. 
+Limits the current search to groups which contain PRINCIPAL_ID as a member  or submember.
+This function gets used by GroupMember->Create to populate subgroups
+
+=cut
+
+sub LimitToGroupsWithMember {
+    my $self = shift;
+    my $member = shift;
+
+    return ($self->Limit( 
+                         VALUE => $member,
+                         FIELD => 'MemberId',
+                         ENTRYAGGREGATOR => 'OR',
+                                   QUOTEVALUE => 0
+                         ));
+
+}
+# }}}
+1;