rt/lib/RT/Transactions.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2015 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 use base 'RT::SearchBuilder';
  73
  74 use RT::Transaction;
  75
  76 sub Table { 'Transactions'}
  77
  78 # {{{ sub _Init
  79 sub _Init   {
  80   my $self = shift;
  81
  82   $self->{'table'} = "Transactions";
  83   $self->{'primary_key'} = "id";
  84
  85   # By default, order by the date of the transaction, rather than ID.
  86   $self->OrderByCols( { FIELD => 'Created',
  87                         ORDER => 'ASC' },
  88                       { FIELD => 'id',
  89                         ORDER => 'ASC' } );
  90
  91   return ( $self->SUPER::_Init(@_));
  92 }
  93
  94 =head2 LimitToTicket TICKETID
  95
  96 Find only transactions for the ticket whose id is TICKETID.
  97
  98 This includes tickets merged into TICKETID.
  99
 100 Repeated calls to this method will intelligently limit down to that set of tickets, joined with an OR
 101
 102
 103 =cut
 104
 105
 106 sub LimitToTicket {
 107     my $self = shift;
 108     my $tid  = shift;
 109
 110     unless ( $self->{'tickets_table'} ) {
 111         $self->{'tickets_table'} ||= $self->Join(
 112             ALIAS1 => 'main',
 113             FIELD1 => 'ObjectId',
 114             TABLE2 => 'Tickets',
 115             FIELD2 => 'id'
 116         );
 117         $self->Limit(
 118             FIELD => 'ObjectType',
 119             VALUE => 'RT::Ticket',
 120         );
 121     }
 122     $self->Limit(
 123         ALIAS           => $self->{tickets_table},
 124         FIELD           => 'EffectiveId',
 125         OPERATOR        => '=',
 126         ENTRYAGGREGATOR => 'OR',
 127         VALUE           => $tid,
 128     );
 129
 130 }
 131
 132
 133 sub AddRecord {
 134     my $self = shift;
 135     my ($record) = @_;
 136
 137     return unless $record->CurrentUserCanSee;
 138     return $self->SUPER::AddRecord($record);
 139 }
 140
 141 RT::Base->_ImportOverlays();
 142
 143 1;