lib/RT/CachedGroupMembers.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2013 Best Practical Solutions, LLC
   6 #                                          <sales@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/licenses/old-licenses/gpl-2.0.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
  49 =head1 NAME
  50
  51   RT::CachedGroupMembers - a collection of RT::GroupMember objects
  52
  53 =head1 SYNOPSIS
  54
  55   use RT::CachedGroupMembers;
  56
  57 =head1 DESCRIPTION
  58
  59
  60 =head1 METHODS
  61
  62
  63
  64 =cut
  65
  66
  67 package RT::CachedGroupMembers;
  68
  69 use strict;
  70 use warnings;
  71
  72
  73 use RT::CachedGroupMember;
  74
  75 use base 'RT::SearchBuilder';
  76
  77 sub Table { 'CachedGroupMembers'}
  78
  79 # {{{ LimitToUsers
  80
  81 =head2 LimitToUsers
  82
  83 Limits this search object to users who are members of this group
  84 This is really useful when you want to have your UI separate out
  85 groups from users for display purposes
  86
  87 =cut
  88
  89 sub LimitToUsers {
  90     my $self = shift;
  91
  92     my $principals = $self->NewAlias('Principals');
  93     $self->Join( ALIAS1 => 'main', FIELD1 => 'MemberId',
  94                  ALIAS2 => $principals, FIELD2 =>'id');
  95
  96     $self->Limit(       ALIAS => $principals,
  97                          FIELD => 'PrincipalType',
  98                          VALUE => 'User',
  99                          ENTRYAGGREGATOR => 'OR',
 100                          );
 101 }
 102
 103
 104
 105
 106 =head2 LimitToGroups
 107
 108 Limits this search object to Groups who are members of this group
 109 This is really useful when you want to have your UI separate out
 110 groups from users for display purposes
 111
 112 =cut
 113
 114 sub LimitToGroups {
 115     my $self = shift;
 116
 117     my $principals = $self->NewAlias('Principals');
 118     $self->Join( ALIAS1 => 'main', FIELD1 => 'MemberId',
 119                  ALIAS2 => $principals, FIELD2 =>'id');
 120
 121     $self->Limit(       ALIAS => $principals,
 122                          FIELD => 'PrincipalType',
 123                          VALUE => 'Group',
 124                          ENTRYAGGREGATOR => 'OR',
 125                          );
 126 }
 127
 128
 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 =head2 LimitToGroupsWithMember PRINCIPAL_ID
 152
 153 Takes a Principal Id as its only argument.
 154 Limits the current search to groups which contain PRINCIPAL_ID as a member  or submember.
 155 This function gets used by GroupMember->Create to populate subgroups
 156
 157 =cut
 158
 159 sub LimitToGroupsWithMember {
 160     my $self = shift;
 161     my $member = shift;
 162
 163
 164
 165     return ($self->Limit(
 166                          VALUE => $member || '0',
 167                          FIELD => 'MemberId',
 168                          ENTRYAGGREGATOR => 'OR',
 169                                     QUOTEVALUE => 0
 170                          ));
 171
 172 }
 173 # }}}
 174
 175
 176 =head2 NewItem
 177
 178 Returns an empty new RT::CachedGroupMember item
 179
 180 =cut
 181
 182 sub NewItem {
 183     my $self = shift;
 184     return(RT::CachedGroupMember->new($self->CurrentUser));
 185 }
 186 RT::Base->_ImportOverlays();
 187
 188 1;