X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=rt%2Flib%2FRT%2FGroupMembers.pm;h=0b56c027b563dce2efceeb59c85e2e502ac41f56;hb=fd4322f01b8c53b3f1f9e54ca15184930b0443de;hp=5d821ad5947e6788de6f665da2a98c3ac60835d1;hpb=5a5e999c1995dc74e90a5bec660e28692b81611e;p=freeside.git diff --git a/rt/lib/RT/GroupMembers.pm b/rt/lib/RT/GroupMembers.pm index 5d821ad59..0b56c027b 100755 --- 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-2012 Best Practical Solutions, LLC # # # (Except where explicitly superseded by other copyright notices) @@ -46,78 +46,119 @@ # # 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; - - =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)); + + my $principals = $self->NewAlias('Principals'); + $self->Join( ALIAS1 => 'main', FIELD1 => 'MemberId', + ALIAS2 => $principals, FIELD2 =>'id'); + + $self->Limit( ALIAS => $principals, + FIELD => 'PrincipalType', + VALUE => 'Group', + ENTRYAGGREGATOR => 'OR', + ); } -RT::Base->_ImportOverlays(); -=head1 SEE ALSO -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. -These overlay files can contain new subs or subs to replace existing subs in this module. +=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 LimitToMembersOfGroup { + my $self = shift; + my $group = shift; + + 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. +=head2 NewItem -RT::GroupMembers_Overlay, RT::GroupMembers_Vendor, RT::GroupMembers_Local +Returns an empty new RT::GroupMember item =cut +sub NewItem { + my $self = shift; + return(RT::GroupMember->new($self->CurrentUser)); +} +RT::Base->_ImportOverlays(); 1;