Upgrade to 4.2.8
[usit-rt.git] / lib / RT / Transactions.pm
CommitLineData
84fb5b46
MKG
1# BEGIN BPS TAGGED BLOCK {{{
2#
3# COPYRIGHT:
4#
3ffc5f4f 5# This software is Copyright (c) 1996-2014 Best Practical Solutions, LLC
84fb5b46
MKG
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
67package RT::Transactions;
68
69use strict;
70use warnings;
71
3ffc5f4f 72use base 'RT::SearchBuilder';
84fb5b46
MKG
73
74use RT::Transaction;
75
84fb5b46
MKG
76sub Table { 'Transactions'}
77
78# {{{ sub _Init
79sub _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',
3ffc5f4f
MKG
87 ORDER => 'ASC' },
88 { FIELD => 'id',
89 ORDER => 'ASC' } );
84fb5b46
MKG
90
91 return ( $self->SUPER::_Init(@_));
92}
93
94=head2 LimitToTicket TICKETID
95
96Find only transactions for the ticket whose id is TICKETID.
97
98This includes tickets merged into TICKETID.
99
100Repeated calls to this method will intelligently limit down to that set of tickets, joined with an OR
101
102
103=cut
104
105
106sub LimitToTicket {
107 my $self = shift;
108 my $tid = shift;
109
110 unless ( $self->{'tickets_table'} ) {
3ffc5f4f 111 $self->{'tickets_table'} ||= $self->Join(
84fb5b46
MKG
112 ALIAS1 => 'main',
113 FIELD1 => 'ObjectId',
3ffc5f4f 114 TABLE2 => 'Tickets',
84fb5b46
MKG
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
133sub Next {
134 my $self = shift;
3ffc5f4f 135
84fb5b46
MKG
136 my $Transaction = $self->SUPER::Next();
137 if ((defined($Transaction)) and (ref($Transaction))) {
3ffc5f4f
MKG
138 # If the user can see the transaction's type, then they can
139 # see the transaction and we should hand it back.
140 if ($Transaction->Type) {
141 return($Transaction);
142 }
143
144 #If the user doesn't have the right to show this ticket
145 else {
146 return($self->Next());
147 }
84fb5b46
MKG
148 }
149
150 #if there never was any ticket
151 else {
3ffc5f4f
MKG
152 return(undef);
153 }
84fb5b46
MKG
154}
155
84fb5b46
MKG
156RT::Base->_ImportOverlays();
157
1581;