Merge branch 'master' of git.freeside.biz:/home/git/freeside
[freeside.git] / rt / lib / RT / Transactions.pm
index 2ae98f2..6794e52 100755 (executable)
@@ -1,4 +1,50 @@
-#$Header: /home/cvs/cvsroot/freeside/rt/lib/RT/Transactions.pm,v 1.1 2002-08-12 06:17:07 ivan Exp $
+# BEGIN BPS TAGGED BLOCK {{{
+#
+# COPYRIGHT:
+#
+# This software is Copyright (c) 1996-2015 Best Practical Solutions, LLC
+#                                          <sales@bestpractical.com>
+#
+# (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.
+#
+# 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
 
 
 =head1 METHODS
 
-=begin testing
-
-ok (require RT::TestHarness);
-ok (require RT::Transactions);
-
-=end testing
 
 =cut
 
+
 package RT::Transactions;
-use RT::EasySearch;
 
-@ISA= qw(RT::EasySearch);
+use strict;
+use warnings;
+
+use base 'RT::SearchBuilder';
+
 use RT::Transaction;
 
+sub Table { 'Transactions'}
+
 # {{{ sub _Init  
 sub _Init   {
   my $self = shift;
@@ -37,42 +83,61 @@ sub _Init   {
   $self->{'primary_key'} = "id";
   
   # By default, order by the date of the transaction, rather than ID.
-  $self->OrderBy( ALIAS => 'main',
-                 FIELD => 'Created',
-                 ORDER => 'ASC');
+  $self->OrderByCols( { FIELD => 'Created',
+                        ORDER => 'ASC' },
+                      { FIELD => 'id',
+                        ORDER => 'ASC' } );
 
   return ( $self->SUPER::_Init(@_));
 }
-# }}}
 
-# {{{ sub NewItem 
-sub NewItem  {
-    my $self = shift;
-    
-    return(RT::Transaction->new($self->CurrentUser));
-}
-# }}}
+=head2 LimitToTicket TICKETID 
 
+Find only transactions for the ticket whose id is TICKETID.
 
-=head2 example methods
+This includes tickets merged into TICKETID.
 
-  Queue RT::Queue or Queue Id
-  Ticket RT::Ticket or Ticket Id
+Repeated calls to this method will intelligently limit down to that set of tickets, joined with an OR
 
 
-LimitDate 
-  
-Type TRANSTYPE
-Field STRING
-OldValue OLDVAL
-NewValue NEWVAL
-Data DATA
-TimeTaken
-Actor USEROBJ/USERID
-ContentMatches STRING
-
 =cut
 
 
-1;
+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,
+    );
+
+}
+
+
+sub AddRecord {
+    my $self = shift;
+    my ($record) = @_;
+
+    return unless $record->CurrentUserCanSee;
+    return $self->SUPER::AddRecord($record);
+}
 
+RT::Base->_ImportOverlays();
+
+1;