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 49415e2..bf03706 100755 (executable)
--- a/rt/lib/RT/GroupMembers.pm
+++ b/rt/lib/RT/GroupMembers.pm
@@ -2,7 +2,7 @@
 #
 # COPYRIGHT:
 #
-# This software is Copyright (c) 1996-2011 Best Practical Solutions, LLC
+# This software is Copyright (c) 1996-2015 Best Practical Solutions, LLC
 #                                          <sales@bestpractical.com>
 #
 # (Except where explicitly superseded by other copyright notices)
@@ -46,95 +46,109 @@
 #
 # END BPS TAGGED BLOCK }}}
 
-# Autogenerated by DBIx::SearchBuilder factory (by <jesse@bestpractical.com>)
-# WARNING: THIS FILE IS AUTOGENERATED. ALL CHANGES TO THIS FILE WILL BE LOST.  
-# 
-# !! DO NOT EDIT THIS FILE !!
-#
-
-use strict;
-
-
 =head1 NAME
 
-  RT::GroupMembers -- Class Description
- 
+  RT::GroupMembers - a collection of RT::GroupMember objects
+
 =head1 SYNOPSIS
 
-  use RT::GroupMembers
+  use RT::GroupMembers;
 
 =head1 DESCRIPTION
 
 
 =head1 METHODS
 
+
+
 =cut
 
-package RT::GroupMembers;
 
-use RT::SearchBuilder;
-use RT::GroupMember;
+package RT::GroupMembers;
 
-use vars qw( @ISA );
-@ISA= qw(RT::SearchBuilder);
+use strict;
+use warnings;
 
+use base 'RT::SearchBuilder';
 
-sub _Init {
-    my $self = shift;
-    $self->{'table'} = 'GroupMembers';
-    $self->{'primary_key'} = 'id';
+use RT::GroupMember;
 
+sub Table { 'GroupMembers'}
 
-    return ( $self->SUPER::_Init(@_) );
-}
 
 
-=head2 NewItem
+=head2 LimitToUsers
 
-Returns an empty new RT::GroupMember item
+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 NewItem {
+sub LimitToUsers {
     my $self = shift;
-    return(RT::GroupMember->new($self->CurrentUser));
+
+    my $principals = $self->Join(
+        ALIAS1 => 'main', FIELD1 => 'MemberId',
+        TABLE2 => 'Principals', FIELD2 =>'id'
+    );
+
+    $self->Limit(       ALIAS => $principals,
+                         FIELD => 'PrincipalType',
+                         VALUE => 'User',
+                         ENTRYAGGREGATOR => 'OR',
+                         );
 }
 
-        eval "require RT::GroupMembers_Overlay";
-        if ($@ && $@ !~ qr{^Can't locate RT/GroupMembers_Overlay.pm}) {
-            die $@;
-        };
 
-        eval "require RT::GroupMembers_Vendor";
-        if ($@ && $@ !~ qr{^Can't locate RT/GroupMembers_Vendor.pm}) {
-            die $@;
-        };
 
-        eval "require RT::GroupMembers_Local";
-        if ($@ && $@ !~ qr{^Can't locate RT/GroupMembers_Local.pm}) {
-            die $@;
-        };
 
+=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
 
-=head1 SEE ALSO
+sub LimitToGroups {
+    my $self = shift;
 
-This class allows "overlay" methods to be placed
-into the following files _Overlay is for a System overlay by the original author,
-_Vendor is for 3rd-party vendor add-ons, while _Local is for site-local customizations.  
+    my $principals = $self->Join(
+        ALIAS1 => 'main', FIELD1 => 'MemberId',
+        TABLE2 => 'Principals', FIELD2 =>'id'
+    );
 
-These overlay files can contain new subs or subs to replace existing subs in this module.
+    $self->Limit(       ALIAS => $principals,
+                         FIELD => 'PrincipalType',
+                         VALUE => 'Group',
+                         ENTRYAGGREGATOR => 'OR',
+                         );
+}
 
-Each of these files should begin with the line 
 
-   no warnings qw(redefine);
 
-so that perl does not kick and scream when you redefine a subroutine or variable in your overlay.
+=head2 LimitToMembersOfGroup PRINCIPAL_ID
 
-RT::GroupMembers_Overlay, RT::GroupMembers_Vendor, RT::GroupMembers_Local
+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',
+                         QUOTEVALUE => 0
+                         ));
+
+}
+
+RT::Base->_ImportOverlays();
 
 1;