rt/lib/RT/Transactions.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2012 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::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 use warnings;
  71
  72
  73 use RT::Transaction;
  74
  75 use base 'RT::SearchBuilder';
  76
  77 sub Table { 'Transactions'}
  78
  79 # {{{ sub _Init
  80 sub _Init   {
  81   my $self = shift;
  82
  83   $self->{'table'} = "Transactions";
  84   $self->{'primary_key'} = "id";
  85
  86   # By default, order by the date of the transaction, rather than ID.
  87   $self->OrderByCols( { FIELD => 'Created',
  88                         ORDER => 'ASC' },
  89                       { FIELD => 'id',
  90                         ORDER => 'ASC' } );
  91
  92   return ( $self->SUPER::_Init(@_));
  93 }
  94
  95 =head2 LimitToTicket TICKETID
  96
  97 Find only transactions for the ticket whose id is TICKETID.
  98
  99 This includes tickets merged into TICKETID.
 100
 101 Repeated calls to this method will intelligently limit down to that set of tickets, joined with an OR
 102
 103
 104 =cut
 105
 106
 107 sub LimitToTicket {
 108     my $self = shift;
 109     my $tid  = shift;
 110
 111     unless ( $self->{'tickets_table'} ) {
 112         $self->{'tickets_table'} ||= $self->NewAlias('Tickets');
 113         $self->Join(
 114             ALIAS1 => 'main',
 115             FIELD1 => 'ObjectId',
 116             ALIAS2 => $self->{'tickets_table'},
 117             FIELD2 => 'id'
 118         );
 119         $self->Limit(
 120             FIELD => 'ObjectType',
 121             VALUE => 'RT::Ticket',
 122         );
 123     }
 124     $self->Limit(
 125         ALIAS           => $self->{tickets_table},
 126         FIELD           => 'EffectiveId',
 127         OPERATOR        => '=',
 128         ENTRYAGGREGATOR => 'OR',
 129         VALUE           => $tid,
 130     );
 131
 132 }
 133
 134
 135 sub Next {
 136     my $self = shift;
 137
 138     my $Transaction = $self->SUPER::Next();
 139     if ((defined($Transaction)) and (ref($Transaction))) {
 140         # If the user can see the transaction's type, then they can
 141         #  see the transaction and we should hand it back.
 142         if ($Transaction->Type) {
 143             return($Transaction);
 144         }
 145
 146         #If the user doesn't have the right to show this ticket
 147         else {
 148             return($self->Next());
 149         }
 150     }
 151
 152     #if there never was any ticket
 153     else {
 154         return(undef);
 155     }
 156 }
 157
 158
 159
 160
 161
 162 =head2 NewItem
 163
 164 Returns an empty new RT::Transaction item
 165
 166 =cut
 167
 168 sub NewItem {
 169     my $self = shift;
 170     return(RT::Transaction->new($self->CurrentUser));
 171 }
 172 RT::Base->_ImportOverlays();
 173
 174 1;