rt/lib/RT/CachedGroupMembers_Overlay.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2007 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., 51 Franklin Street, Fifth Floor, Boston, MA
  26 # 02110-1301 or visit their web page on the internet at
  27 # http://www.gnu.org/copyleft/gpl.html.
  28 #
  29 #
  30 # CONTRIBUTION SUBMISSION POLICY:
  31 #
  32 # (The following paragraph is not intended to limit the rights granted
  33 # to you to modify and distribute this software under the terms of
  34 # the GNU General Public License and is only of importance to you if
  35 # you choose to contribute your changes and enhancements to the
  36 # community by submitting them to Best Practical Solutions, LLC.)
  37 #
  38 # By intentionally submitting any modifications, corrections or
  39 # derivatives to this work, or any other work intended for use with
  40 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
  41 # you are the copyright holder for those contributions and you grant
  42 # Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
  43 # royalty-free, perpetual, license to use, copy, create derivative
  44 # works based on those contributions, and sublicense and distribute
  45 # those contributions and any derivatives thereof.
  46 #
  47 # END BPS TAGGED BLOCK }}}
  48 =head1 NAME
  49
  50   RT::CachedGroupMembers - a collection of RT::GroupMember objects
  51
  52 =head1 SYNOPSIS
  53
  54   use RT::CachedGroupMembers;
  55
  56 =head1 DESCRIPTION
  57
  58
  59 =head1 METHODS
  60
  61
  62 =begin testing
  63
  64 ok (require RT::CachedGroupMembers);
  65
  66 =end testing
  67
  68 =cut
  69
  70
  71 package RT::CachedGroupMembers;
  72
  73 use strict;
  74 no warnings qw(redefine);
  75
  76 # {{{ LimitToUsers
  77
  78 =head2 LimitToUsers
  79
  80 Limits this search object to users who are members of this group
  81 This is really useful when you want to have your UI separate out
  82 groups from users for display purposes
  83
  84 =cut
  85
  86 sub LimitToUsers {
  87     my $self = shift;
  88
  89     my $principals = $self->NewAlias('Principals');
  90     $self->Join( ALIAS1 => 'main', FIELD1 => 'MemberId',
  91                  ALIAS2 => $principals, FIELD2 =>'id');
  92
  93     $self->Limit(       ALIAS => $principals,
  94                          FIELD => 'PrincipalType',
  95                          VALUE => 'User',
  96                          ENTRYAGGREGATOR => 'OR',
  97                          );
  98 }
  99
 100 # }}}
 101
 102
 103 # {{{ LimitToGroups
 104
 105 =head2 LimitToGroups
 106
 107 Limits this search object to Groups who are members of this group
 108 This is really useful when you want to have your UI separate out
 109 groups from users for display purposes
 110
 111 =cut
 112
 113 sub LimitToGroups {
 114     my $self = shift;
 115
 116     my $principals = $self->NewAlias('Principals');
 117     $self->Join( ALIAS1 => 'main', FIELD1 => 'MemberId',
 118                  ALIAS2 => $principals, FIELD2 =>'id');
 119
 120     $self->Limit(       ALIAS => $principals,
 121                          FIELD => 'PrincipalType',
 122                          VALUE => 'Group',
 123                          ENTRYAGGREGATOR => 'OR',
 124                          );
 125 }
 126
 127 # }}}
 128
 129 # {{{ sub LimitToMembersOfGroup
 130
 131 =head2 LimitToMembersOfGroup PRINCIPAL_ID
 132
 133 Takes a Principal Id as its only argument.
 134 Limits the current search principals which are _directly_ members
 135 of the group which has PRINCIPAL_ID as its principal id.
 136
 137 =cut
 138
 139 sub LimitToMembersOfGroup {
 140     my $self = shift;
 141     my $group = shift;
 142
 143     return ($self->Limit(
 144                          VALUE => $group,
 145                          FIELD => 'GroupId',
 146                          ENTRYAGGREGATOR => 'OR',
 147                          ));
 148
 149 }
 150 # }}}
 151
 152 # {{{ sub LimitToGroupsWithMember
 153
 154 =head2 LimitToGroupsWithMember PRINCIPAL_ID
 155
 156 Takes a Principal Id as its only argument.
 157 Limits the current search to groups which contain PRINCIPAL_ID as a member  or submember.
 158 This function gets used by GroupMember->Create to populate subgroups
 159
 160 =cut
 161
 162 sub LimitToGroupsWithMember {
 163     my $self = shift;
 164     my $member = shift;
 165
 166
 167
 168     return ($self->Limit(
 169                          VALUE => $member || '0',
 170                          FIELD => 'MemberId',
 171                          ENTRYAGGREGATOR => 'OR',
 172                                     QUOTEVALUE => 0
 173                          ));
 174
 175 }
 176 # }}}
 177 1;