rt/lib/RT/Transactions_Overlay.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2009 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/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::Transactions - a collection of RT Transaction objects
  52
  53 =head1 SYNOPSIS
  54
  55   use RT::Transactions;
  56
  57
  58 =head1 DESCRIPTION
  59
  60
  61 =head1 METHODS
  62
  63
  64 =cut
  65
  66
  67 package RT::Transactions;
  68
  69 use strict;
  70 no warnings qw(redefine);
  71
  72 # {{{ sub _Init
  73 sub _Init   {
  74   my $self = shift;
  75
  76   $self->{'table'} = "Transactions";
  77   $self->{'primary_key'} = "id";
  78
  79   # By default, order by the date of the transaction, rather than ID.
  80   $self->OrderByCols( { FIELD => 'Created',
  81                         ORDER => 'ASC' },
  82                       { FIELD => 'id',
  83                         ORDER => 'ASC' } );
  84
  85   return ( $self->SUPER::_Init(@_));
  86 }
  87 # }}}
  88
  89 =head2 LimitToTicket TICKETID
  90
  91 Find only transactions for the ticket whose id is TICKETID.
  92
  93 This includes tickets merged into TICKETID.
  94
  95 Repeated calls to this method will intelligently limit down to that set of tickets, joined with an OR
  96
  97
  98 =cut
  99
 100
 101 sub LimitToTicket {
 102     my $self = shift;
 103     my $tid  = shift;
 104
 105     unless ( $self->{'tickets_table'} ) {
 106         $self->{'tickets_table'} ||= $self->NewAlias('Tickets');
 107         $self->Join(
 108             ALIAS1 => 'main',
 109             FIELD1 => 'ObjectId',
 110             ALIAS2 => $self->{'tickets_table'},
 111             FIELD2 => 'id'
 112         );
 113         $self->Limit(
 114             FIELD => 'ObjectType',
 115             VALUE => 'RT::Ticket',
 116         );
 117     }
 118     $self->Limit(
 119         ALIAS           => $self->{tickets_table},
 120         FIELD           => 'EffectiveId',
 121         OPERATOR        => '=',
 122         ENTRYAGGREGATOR => 'OR',
 123         VALUE           => $tid,
 124     );
 125
 126 }
 127
 128
 129 # {{{ sub Next
 130 sub Next {
 131     my $self = shift;
 132
 133     my $Transaction = $self->SUPER::Next();
 134     if ((defined($Transaction)) and (ref($Transaction))) {
 135         # If the user can see the transaction's type, then they can
 136         #  see the transaction and we should hand it back.
 137         if ($Transaction->Type) {
 138             return($Transaction);
 139         }
 140
 141         #If the user doesn't have the right to show this ticket
 142         else {
 143             return($self->Next());
 144         }
 145     }
 146
 147     #if there never was any ticket
 148     else {
 149         return(undef);
 150     }
 151 }
 152 # }}}
 153
 154
 155
 156 1;
 157