rt/lib/RT/CachedGroupMembers_Overlay.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2005 Best Practical Solutions, LLC
   6 #                                          <jesse@bestpractical.com>
   7 #
   8 # (Except where explicitly superseded by other copyright notices)
   9 #
  10 #
  11 # LICENSE:
  12 #
  13 # This work is made available to you under the terms of Version 2 of
  14 # the GNU General Public License. A copy of that license should have
  15 # been provided with this software, but in any event can be snarfed
  16 # from www.gnu.org.
  17 #
  18 # This work is distributed in the hope that it will be useful, but
  19 # WITHOUT ANY WARRANTY; without even the implied warranty of
  20 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  21 # General Public License for more details.
  22 #
  23 # You should have received a copy of the GNU General Public License
  24 # along with this program; if not, write to the Free Software
  25 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  26 #
  27 #
  28 # CONTRIBUTION SUBMISSION POLICY:
  29 #
  30 # (The following paragraph is not intended to limit the rights granted
  31 # to you to modify and distribute this software under the terms of
  32 # the GNU General Public License and is only of importance to you if
  33 # you choose to contribute your changes and enhancements to the
  34 # community by submitting them to Best Practical Solutions, LLC.)
  35 #
  36 # By intentionally submitting any modifications, corrections or
  37 # derivatives to this work, or any other work intended for use with
  38 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
  39 # you are the copyright holder for those contributions and you grant
  40 # Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
  41 # royalty-free, perpetual, license to use, copy, create derivative
  42 # works based on those contributions, and sublicense and distribute
  43 # those contributions and any derivatives thereof.
  44 #
  45 # END BPS TAGGED BLOCK }}}
  46
  47 =head1 NAME
  48
  49   RT::CachedGroupMembers - a collection of RT::GroupMember objects
  50
  51 =head1 SYNOPSIS
  52
  53   use RT::CachedGroupMembers;
  54
  55 =head1 DESCRIPTION
  56
  57
  58 =head1 METHODS
  59
  60
  61 =begin testing
  62
  63 ok (require RT::CachedGroupMembers);
  64
  65 =end testing
  66
  67 =cut
  68
  69
  70 package RT::CachedGroupMembers;
  71
  72 use strict;
  73 no warnings qw(redefine);
  74
  75 # {{{ LimitToUsers
  76
  77 =head2 LimitToUsers
  78
  79 Limits this search object to users who are members of this group
  80 This is really useful when you want to have your UI separate out
  81 groups from users for display purposes
  82
  83 =cut
  84
  85 sub LimitToUsers {
  86     my $self = shift;
  87
  88     my $principals = $self->NewAlias('Principals');
  89     $self->Join( ALIAS1 => 'main', FIELD1 => 'MemberId',
  90                  ALIAS2 => $principals, FIELD2 =>'id');
  91
  92     $self->Limit(       ALIAS => $principals,
  93                          FIELD => 'PrincipalType',
  94                          VALUE => 'User',
  95                          ENTRYAGGREGATOR => 'OR',
  96                          );
  97 }
  98
  99 # }}}
 100
 101
 102 # {{{ LimitToGroups
 103
 104 =head2 LimitToGroups
 105
 106 Limits this search object to Groups who are members of this group
 107 This is really useful when you want to have your UI separate out
 108 groups from users for display purposes
 109
 110 =cut
 111
 112 sub LimitToGroups {
 113     my $self = shift;
 114
 115     my $principals = $self->NewAlias('Principals');
 116     $self->Join( ALIAS1 => 'main', FIELD1 => 'MemberId',
 117                  ALIAS2 => $principals, FIELD2 =>'id');
 118
 119     $self->Limit(       ALIAS => $principals,
 120                          FIELD => 'PrincipalType',
 121                          VALUE => 'Group',
 122                          ENTRYAGGREGATOR => 'OR',
 123                          );
 124 }
 125
 126 # }}}
 127
 128 # {{{ sub LimitToMembersOfGroup
 129
 130 =head2 LimitToMembersOfGroup PRINCIPAL_ID
 131
 132 Takes a Principal Id as its only argument.
 133 Limits the current search principals which are _directly_ members
 134 of the group which has PRINCIPAL_ID as its principal id.
 135
 136 =cut
 137
 138 sub LimitToMembersOfGroup {
 139     my $self = shift;
 140     my $group = shift;
 141
 142     return ($self->Limit(
 143                          VALUE => $group,
 144                          FIELD => 'GroupId',
 145                          ENTRYAGGREGATOR => 'OR',
 146                          ));
 147
 148 }
 149 # }}}
 150
 151 # {{{ sub LimitToGroupsWithMember
 152
 153 =head2 LimitToGroupsWithMember PRINCIPAL_ID
 154
 155 Takes a Principal Id as its only argument.
 156 Limits the current search to groups which contain PRINCIPAL_ID as a member  or submember.
 157 This function gets used by GroupMember->Create to populate subgroups
 158
 159 =cut
 160
 161 sub LimitToGroupsWithMember {
 162     my $self = shift;
 163     my $member = shift;
 164
 165
 166
 167     return ($self->Limit(
 168                          VALUE => $member || '0',
 169                          FIELD => 'MemberId',
 170                          ENTRYAGGREGATOR => 'OR',
 171                                     QUOTEVALUE => 0
 172                          ));
 173
 174 }
 175 # }}}
 176 1;