Merge branch 'master' of git.freeside.biz:/home/git/freeside

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

diff --git a/rt/lib/RT/GroupMembers.pm b/rt/lib/RT/GroupMembers.pm
index a90a2a8..bf03706 100755 (executable)
--- a/rt/lib/RT/GroupMembers.pm
+++ b/rt/lib/RT/GroupMembers.pm
@@ -1,4 +1,50 @@
-#$Header: /home/cvs/cvsroot/freeside/rt/lib/RT/GroupMembers.pm,v 1.1 2002-08-12 06:17:07 ivan Exp $
+# BEGIN BPS TAGGED BLOCK {{{
+#
+# COPYRIGHT:
+#
+# This software is Copyright (c) 1996-2015 Best Practical Solutions, LLC
+#                                          <sales@bestpractical.com>
+#
+# (Except where explicitly superseded by other copyright notices)
+#
+#
+# LICENSE:
+#
+# 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.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+# 02110-1301 or visit their web page on the internet at
+# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
+#
+#
+# CONTRIBUTION SUBMISSION POLICY:
+#
+# (The following paragraph is not intended to limit the rights granted
+# to you to modify and distribute this software under the terms of
+# the GNU General Public License and is only of importance to you if
+# you choose to contribute your changes and enhancements to the
+# community by submitting them to Best Practical Solutions, LLC.)
+#
+# By intentionally submitting any modifications, corrections or
+# derivatives to this work, or any other work intended for use with
+# Request Tracker, to Best Practical Solutions, LLC, you confirm that
+# you are the copyright holder for those contributions and you grant
+# Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
+# royalty-free, perpetual, license to use, copy, create derivative
+# works based on those contributions, and sublicense and distribute
+# those contributions and any derivatives thereof.
+#
+# END BPS TAGGED BLOCK }}}
 
 =head1 NAME
 
@@ -14,60 +60,95 @@
 =head1 METHODS
 
 
-=begin testing
-
-ok (require RT::TestHarness);
-ok (require RT::GroupMembers);
-
-=end testing
 
 =cut
 
+
 package RT::GroupMembers;
-use RT::EasySearch;
+
+use strict;
+use warnings;
+
+use base 'RT::SearchBuilder';
+
 use RT::GroupMember;
 
-@ISA= qw(RT::EasySearch);
+sub Table { 'GroupMembers'}
+
+
+
+=head2 LimitToUsers
+
+Limits this search object to users who are members of this group.
+This is really useful when you want to have your UI separate out
+groups from users for display purposes
+
+=cut
+
+sub LimitToUsers {
+    my $self = shift;
+
+    my $principals = $self->Join(
+        ALIAS1 => 'main', FIELD1 => 'MemberId',
+        TABLE2 => 'Principals', FIELD2 =>'id'
+    );
+
+    $self->Limit(       ALIAS => $principals,
+                         FIELD => 'PrincipalType',
+                         VALUE => 'User',
+                         ENTRYAGGREGATOR => 'OR',
+                         );
+}
+
+
+
+
+=head2 LimitToGroups
+
+Limits this search object to Groups who are members of this group.
+This is really useful when you want to have your UI separate out
+groups from users for display purposes
+
+=cut
+
+sub LimitToGroups {
+    my $self = shift;
 
+    my $principals = $self->Join(
+        ALIAS1 => 'main', FIELD1 => 'MemberId',
+        TABLE2 => 'Principals', FIELD2 =>'id'
+    );
 
-# {{{ sub _Init  
-sub _Init   {
-  my $self = shift;
- 
-  $self->{'table'} = "GroupMembers";
-  $self->{'primary_key'} = "id";
-  return ( $self->SUPER::_Init(@_) );
+    $self->Limit(       ALIAS => $principals,
+                         FIELD => 'PrincipalType',
+                         VALUE => 'Group',
+                         ENTRYAGGREGATOR => 'OR',
+                         );
 }
-# }}}
 
-# {{{ sub LimitToGroup
 
-=head2 LimitToGroup
 
-Takes a group id as its only argument.  Limits the current search to that
-group object
+=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 LimitToGroup {
+sub LimitToMembersOfGroup {
     my $self = shift;
     my $group = shift;
 
     return ($self->Limit( 
-                         VALUE => "$group",
+                         VALUE => $group,
                          FIELD => 'GroupId',
                          ENTRYAGGREGATOR => 'OR',
+                         QUOTEVALUE => 0
                          ));
 
 }
-# }}}
-
-# {{{ sub NewItem 
 
-sub NewItem  {
-    my $self = shift;
-    return(RT::GroupMember->new($self->CurrentUser))
-}
+RT::Base->_ImportOverlays();
 
-# }}}
 1;