X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=rt%2Flib%2FRT%2FGroupMembers.pm;h=a5e88400555f94babaa2145b77850e1f4a4de711;hb=31f3763747b82764bb019cfab5b2a2945fc9a99d;hp=978bbbaecf365f4e74697482ecf3dcbc617c89a3;hpb=8103c1fc1b2c27a6855feadf26f91b980a54bc52;p=freeside.git diff --git a/rt/lib/RT/GroupMembers.pm b/rt/lib/RT/GroupMembers.pm index 978bbbaec..a5e884005 100755 --- a/rt/lib/RT/GroupMembers.pm +++ b/rt/lib/RT/GroupMembers.pm @@ -1,40 +1,40 @@ # BEGIN BPS TAGGED BLOCK {{{ -# +# # COPYRIGHT: -# -# This software is Copyright (c) 1996-2007 Best Practical Solutions, LLC -# -# +# +# 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. -# +# # 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/copyleft/gpl.html. -# -# +# 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 @@ -43,97 +43,122 @@ # 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::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 strict; +use warnings; + use RT::GroupMember; -use vars qw( @ISA ); -@ISA= qw(RT::SearchBuilder); +use base 'RT::SearchBuilder'; + +sub Table { 'GroupMembers'} -sub _Init { + +=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; - $self->{'table'} = 'GroupMembers'; - $self->{'primary_key'} = 'id'; + my $principals = $self->NewAlias('Principals'); + $self->Join( ALIAS1 => 'main', FIELD1 => 'MemberId', + ALIAS2 => $principals, FIELD2 =>'id'); - return ( $self->SUPER::_Init(@_) ); + $self->Limit( ALIAS => $principals, + FIELD => 'PrincipalType', + VALUE => 'User', + ENTRYAGGREGATOR => 'OR', + ); } -=head2 NewItem -Returns an empty new RT::GroupMember 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::GroupMember->new($self->CurrentUser)); -} - eval "require RT::GroupMembers_Overlay"; - if ($@ && $@ !~ qr{^Can't locate RT/GroupMembers_Overlay.pm}) { - die $@; - }; + my $principals = $self->NewAlias('Principals'); + $self->Join( ALIAS1 => 'main', FIELD1 => 'MemberId', + ALIAS2 => $principals, FIELD2 =>'id'); - eval "require RT::GroupMembers_Vendor"; - if ($@ && $@ !~ qr{^Can't locate RT/GroupMembers_Vendor.pm}) { - die $@; - }; + $self->Limit( ALIAS => $principals, + FIELD => 'PrincipalType', + VALUE => 'Group', + ENTRYAGGREGATOR => 'OR', + ); +} - eval "require RT::GroupMembers_Local"; - if ($@ && $@ !~ qr{^Can't locate RT/GroupMembers_Local.pm}) { - die $@; - }; +=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. -=head1 SEE ALSO +=cut -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. +sub LimitToMembersOfGroup { + my $self = shift; + my $group = shift; -These overlay files can contain new subs or subs to replace existing subs in this module. + return ($self->Limit( + VALUE => $group, + FIELD => 'GroupId', + ENTRYAGGREGATOR => 'OR', + QUOTEVALUE => 0 + )); -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. -RT::GroupMembers_Overlay, RT::GroupMembers_Vendor, RT::GroupMembers_Local +=head2 NewItem + +Returns an empty new RT::GroupMember item =cut +sub NewItem { + my $self = shift; + return(RT::GroupMember->new($self->CurrentUser)); +} +RT::Base->_ImportOverlays(); 1;