Merge branch 'master' of git.freeside.biz:/home/git/freeside

[freeside.git] / rt / lib / RT / Transactions.pm

diff --git a/rt/lib/RT/Transactions.pm b/rt/lib/RT/Transactions.pm
index 8ba1a96..6794e52 100755 (executable)
--- a/rt/lib/RT/Transactions.pm
+++ b/rt/lib/RT/Transactions.pm
@@ -2,7 +2,7 @@
 #
 # COPYRIGHT:
 #
-# This software is Copyright (c) 1996-2011 Best Practical Solutions, LLC
+# This software is Copyright (c) 1996-2015 Best Practical Solutions, LLC
 #                                          <sales@bestpractical.com>
 #
 # (Except where explicitly superseded by other copyright notices)
@@ -46,95 +46,98 @@
 #
 # END BPS TAGGED BLOCK }}}
 
-# Autogenerated by DBIx::SearchBuilder factory (by <jesse@bestpractical.com>)
-# WARNING: THIS FILE IS AUTOGENERATED. ALL CHANGES TO THIS FILE WILL BE LOST.  
-# 
-# !! DO NOT EDIT THIS FILE !!
-#
-
-use strict;
-
-
 =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 vars qw( @ISA );
-@ISA= qw(RT::SearchBuilder);
-
-
-sub _Init {
-    my $self = shift;
-    $self->{'table'} = 'Transactions';
-    $self->{'primary_key'} = 'id';
 
+=cut
 
-    return ( $self->SUPER::_Init(@_) );
-}
 
+package RT::Transactions;
 
-=head2 NewItem
+use strict;
+use warnings;
 
-Returns an empty new RT::Transaction item
+use base 'RT::SearchBuilder';
 
-=cut
+use RT::Transaction;
 
-sub NewItem {
-    my $self = shift;
-    return(RT::Transaction->new($self->CurrentUser));
+sub Table { 'Transactions'}
+
+# {{{ 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(@_));
 }
 
-        eval "require RT::Transactions_Overlay";
-        if ($@ && $@ !~ qr{^Can't locate RT/Transactions_Overlay.pm}) {
-            die $@;
-        };
-
-        eval "require RT::Transactions_Vendor";
-        if ($@ && $@ !~ qr{^Can't locate RT/Transactions_Vendor.pm}) {
-            die $@;
-        };
+=head2 LimitToTicket TICKETID 
 
-        eval "require RT::Transactions_Local";
-        if ($@ && $@ !~ qr{^Can't locate RT/Transactions_Local.pm}) {
-            die $@;
-        };
+Find only transactions for the ticket whose id is TICKETID.
 
+This includes tickets merged into TICKETID.
 
+Repeated calls to this method will intelligently limit down to that set of tickets, joined with an OR
 
 
-=head1 SEE ALSO
-
-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.  
+=cut
 
-These overlay files can contain new subs or subs to replace existing subs in this module.
 
-Each of these files should begin with the line 
+sub LimitToTicket {
+    my $self = shift;
+    my $tid  = shift;
+
+    unless ( $self->{'tickets_table'} ) {
+        $self->{'tickets_table'} ||= $self->Join(
+            ALIAS1 => 'main',
+            FIELD1 => 'ObjectId',
+            TABLE2 => 'Tickets',
+            FIELD2 => 'id'
+        );
+        $self->Limit(
+            FIELD => 'ObjectType',
+            VALUE => 'RT::Ticket',
+        );
+    }
+    $self->Limit(
+        ALIAS           => $self->{tickets_table},
+        FIELD           => 'EffectiveId',
+        OPERATOR        => '=',
+        ENTRYAGGREGATOR => 'OR',
+        VALUE           => $tid,
+    );
 
-   no warnings qw(redefine);
+}
 
-so that perl does not kick and scream when you redefine a subroutine or variable in your overlay.
 
-RT::Transactions_Overlay, RT::Transactions_Vendor, RT::Transactions_Local
+sub AddRecord {
+    my $self = shift;
+    my ($record) = @_;
 
-=cut
+    return unless $record->CurrentUserCanSee;
+    return $self->SUPER::AddRecord($record);
+}
 
+RT::Base->_ImportOverlays();
 
 1;