X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=rt%2Flib%2FRT%2FGroupMembers.pm;h=bf0370630eb7e642cd298121f53c0ef19b5072c6;hp=31cb9536f76aebf678d749493555a8baf5d25849;hb=9aee669886202be7035e6c6049fc71bc99dd3013;hpb=673b9a458d9138523026963df6fa3b4683e09bae diff --git a/rt/lib/RT/GroupMembers.pm b/rt/lib/RT/GroupMembers.pm index 31cb9536f..bf0370630 100755 --- a/rt/lib/RT/GroupMembers.pm +++ b/rt/lib/RT/GroupMembers.pm @@ -1,115 +1,154 @@ -# BEGIN LICENSE BLOCK -# -# Copyright (c) 1996-2003 Jesse Vincent -# -# (Except where explictly superceded by other copyright notices) -# +# BEGIN BPS TAGGED BLOCK {{{ +# +# COPYRIGHT: +# +# This software is Copyright (c) 1996-2015 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. -# -# 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 -# 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; - +# 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 - 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(@_) ); -} -=item 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', + ); +} -If you'll be working with perl 5.6.0 or greater, 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;