X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=rt%2Flib%2FRT%2FTransactions.pm;h=9c359c07f294f2fbc4293ffc3cf8ccf6671309e2;hb=31f3763747b82764bb019cfab5b2a2945fc9a99d;hp=23a475ac6f961c47492d78af9ce4c40921297718;hpb=63a268637b2d51a8766412617724b9436439deb6;p=freeside.git diff --git a/rt/lib/RT/Transactions.pm b/rt/lib/RT/Transactions.pm index 23a475ac6..9c359c07f 100755 --- a/rt/lib/RT/Transactions.pm +++ b/rt/lib/RT/Transactions.pm @@ -1,115 +1,159 @@ -# BEGIN LICENSE BLOCK -# -# Copyright (c) 1996-2003 Jesse Vincent -# -# (Except where explictly superceded by other copyright notices) -# +# BEGIN BPS TAGGED BLOCK {{{ +# +# COPYRIGHT: +# +# This software is Copyright (c) 1996-2015 Best Practical Solutions, LLC +# +# +# (Except where explicitly superseded by other copyright notices) +# +# +# LICENSE: +# # This work is made available to you under the terms of Version 2 of # the GNU General Public License. A copy of that license should have # been provided with this software, but in any event can be snarfed # from www.gnu.org. -# +# # This work is distributed in the hope that it will be useful, but # WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU # General Public License for more details. -# -# Unless otherwise specified, all modifications, corrections or -# extensions to this work which alter its source code become the -# property of Best Practical Solutions, LLC when submitted for -# inclusion in the work. -# -# -# END LICENSE BLOCK -# Autogenerated by DBIx::SearchBuilder factory (by ) -# WARNING: THIS FILE IS AUTOGENERATED. ALL CHANGES TO THIS FILE WILL BE LOST. -# -# !! DO NOT EDIT THIS FILE !! # - -use strict; - +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA +# 02110-1301 or visit their web page on the internet at +# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html. +# +# +# CONTRIBUTION SUBMISSION POLICY: +# +# (The following paragraph is not intended to limit the rights granted +# to you to modify and distribute this software under the terms of +# the GNU General Public License and is only of importance to you if +# you choose to contribute your changes and enhancements to the +# community by submitting them to Best Practical Solutions, LLC.) +# +# By intentionally submitting any modifications, corrections or +# derivatives to this work, or any other work intended for use with +# Request Tracker, to Best Practical Solutions, LLC, you confirm that +# you are the copyright holder for those contributions and you grant +# Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable, +# royalty-free, perpetual, license to use, copy, create derivative +# works based on those contributions, and sublicense and distribute +# those contributions and any derivatives thereof. +# +# END BPS TAGGED BLOCK }}} =head1 NAME - RT::Transactions -- Class Description - + RT::Transactions - a collection of RT Transaction objects + =head1 SYNOPSIS - use RT::Transactions + use RT::Transactions; + =head1 DESCRIPTION =head1 METHODS + =cut + package RT::Transactions; -use RT::SearchBuilder; -use RT::Transaction; +use strict; +use warnings; -use vars qw( @ISA ); -@ISA= qw(RT::SearchBuilder); +use RT::Transaction; -sub _Init { - my $self = shift; - $self->{'table'} = 'Transactions'; - $self->{'primary_key'} = 'id'; +use base 'RT::SearchBuilder'; +sub Table { 'Transactions'} - return ( $self->SUPER::_Init(@_) ); +# {{{ sub _Init +sub _Init { + my $self = shift; + + $self->{'table'} = "Transactions"; + $self->{'primary_key'} = "id"; + + # By default, order by the date of the transaction, rather than ID. + $self->OrderByCols( { FIELD => 'Created', + ORDER => 'ASC' }, + { FIELD => 'id', + ORDER => 'ASC' } ); + + return ( $self->SUPER::_Init(@_)); } +=head2 LimitToTicket TICKETID -=item NewItem +Find only transactions for the ticket whose id is TICKETID. -Returns an empty new RT::Transaction item +This includes tickets merged into TICKETID. -=cut +Repeated calls to this method will intelligently limit down to that set of tickets, joined with an OR -sub NewItem { - my $self = shift; - return(RT::Transaction->new($self->CurrentUser)); -} - eval "require RT::Transactions_Overlay"; - if ($@ && $@ !~ qr{^Can't locate RT/Transactions_Overlay.pm}) { - die $@; - }; +=cut - eval "require RT::Transactions_Vendor"; - if ($@ && $@ !~ qr{^Can't locate RT/Transactions_Vendor.pm}) { - die $@; - }; - eval "require RT::Transactions_Local"; - if ($@ && $@ !~ qr{^Can't locate RT/Transactions_Local.pm}) { - die $@; - }; +sub LimitToTicket { + my $self = shift; + my $tid = shift; + + unless ( $self->{'tickets_table'} ) { + $self->{'tickets_table'} ||= $self->NewAlias('Tickets'); + $self->Join( + ALIAS1 => 'main', + FIELD1 => 'ObjectId', + ALIAS2 => $self->{'tickets_table'}, + FIELD2 => 'id' + ); + $self->Limit( + FIELD => 'ObjectType', + VALUE => 'RT::Ticket', + ); + } + $self->Limit( + ALIAS => $self->{tickets_table}, + FIELD => 'EffectiveId', + OPERATOR => '=', + ENTRYAGGREGATOR => 'OR', + VALUE => $tid, + ); +} +sub AddRecord { + my $self = shift; + my ($record) = @_; -=head1 SEE ALSO + return unless $record->CurrentUserCanSee; + return $self->SUPER::AddRecord($record); +} -This class allows "overlay" methods to be placed -into the following files _Overlay is for a System overlay by the original author, -_Vendor is for 3rd-party vendor add-ons, while _Local is for site-local customizations. -These overlay files can contain new subs or subs to replace existing subs in this module. -If you'll be working with perl 5.6.0 or greater, each of these files should begin with the line - no warnings qw(redefine); -so that perl does not kick and scream when you redefine a subroutine or variable in your overlay. +=head2 NewItem -RT::Transactions_Overlay, RT::Transactions_Vendor, RT::Transactions_Local +Returns an empty new RT::Transaction item =cut +sub NewItem { + my $self = shift; + return(RT::Transaction->new($self->CurrentUser)); +} +RT::Base->_ImportOverlays(); 1;