X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=rt%2Flib%2FRT%2FCachedGroupMembers.pm;h=cb483cb43696a99384fd14f48e16ea4a2593fcd4;hp=5ed35e676d68524385a272bc27ec14a0f51352ae;hb=7322f2afedcc2f427e997d1535a503613a83f088;hpb=d4d0590bef31071e8809ec046717444b95b3f30a diff --git a/rt/lib/RT/CachedGroupMembers.pm b/rt/lib/RT/CachedGroupMembers.pm index 5ed35e676..cb483cb43 100644 --- a/rt/lib/RT/CachedGroupMembers.pm +++ b/rt/lib/RT/CachedGroupMembers.pm @@ -1,38 +1,40 @@ # BEGIN BPS TAGGED BLOCK {{{ -# +# # COPYRIGHT: -# -# This software is Copyright (c) 1996-2005 Best Practical Solutions, LLC -# -# +# +# This software is Copyright (c) 1996-2016 Best Practical Solutions, LLC +# +# # (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., 675 Mass Ave, Cambridge, MA 02139, USA. -# -# +# 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 @@ -41,97 +43,138 @@ # 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 }}} -# Autogenerated by DBIx::SearchBuilder factory (by ) -# WARNING: THIS FILE IS AUTOGENERATED. ALL CHANGES TO THIS FILE WILL BE LOST. -# -# !! DO NOT EDIT THIS FILE !! # - -use strict; - +# END BPS TAGGED BLOCK }}} =head1 NAME - RT::CachedGroupMembers -- Class Description - + RT::CachedGroupMembers - a collection of RT::GroupMember objects + =head1 SYNOPSIS - use RT::CachedGroupMembers + use RT::CachedGroupMembers; =head1 DESCRIPTION =head1 METHODS + + =cut + package RT::CachedGroupMembers; -use RT::SearchBuilder; +use strict; +use warnings; + +use base 'RT::SearchBuilder'; + use RT::CachedGroupMember; -use vars qw( @ISA ); -@ISA= qw(RT::SearchBuilder); +sub Table { 'CachedGroupMembers'} + +# {{{ LimitToUsers +=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 _Init { +sub LimitToUsers { my $self = shift; - $self->{'table'} = 'CachedGroupMembers'; - $self->{'primary_key'} = 'id'; + my $principals = $self->Join( + ALIAS1 => 'main', FIELD1 => 'MemberId', + TABLE2 => 'Principals', FIELD2 =>'id' + ); - return ( $self->SUPER::_Init(@_) ); + $self->Limit( ALIAS => $principals, + FIELD => 'PrincipalType', + VALUE => 'User', + ENTRYAGGREGATOR => 'OR', + ); } -=head2 NewItem -Returns an empty new RT::CachedGroupMember item + +=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 NewItem { +sub LimitToGroups { my $self = shift; - return(RT::CachedGroupMember->new($self->CurrentUser)); -} - eval "require RT::CachedGroupMembers_Overlay"; - if ($@ && $@ !~ qr{^Can't locate RT/CachedGroupMembers_Overlay.pm}) { - die $@; - }; + my $principals = $self->Join( + ALIAS1 => 'main', FIELD1 => 'MemberId', + TABLE2 => 'Principals', FIELD2 =>'id' + ); - eval "require RT::CachedGroupMembers_Vendor"; - if ($@ && $@ !~ qr{^Can't locate RT/CachedGroupMembers_Vendor.pm}) { - die $@; - }; - eval "require RT::CachedGroupMembers_Local"; - if ($@ && $@ !~ qr{^Can't locate RT/CachedGroupMembers_Local.pm}) { - die $@; - }; + $self->Limit( ALIAS => $principals, + FIELD => 'PrincipalType', + VALUE => 'Group', + ENTRYAGGREGATOR => 'OR', + ); +} +=head2 LimitToMembersOfGroup PRINCIPAL_ID -=head1 SEE ALSO +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. -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. +=cut -These overlay files can contain new subs or subs to replace existing subs in this module. +sub LimitToMembersOfGroup { + my $self = shift; + my $group = shift; + + return ($self->Limit( + VALUE => $group, + FIELD => 'GroupId', + 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 LimitToGroupsWithMember PRINCIPAL_ID -RT::CachedGroupMembers_Overlay, RT::CachedGroupMembers_Vendor, RT::CachedGroupMembers_Local +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 || '0', + FIELD => 'MemberId', + ENTRYAGGREGATOR => 'OR', + QUOTEVALUE => 0 + )); + +} +# }}} + + +RT::Base->_ImportOverlays(); 1;