import rt 3.4.4

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

diff --git a/rt/lib/RT/ObjectCustomFieldValues_Overlay.pm b/rt/lib/RT/ObjectCustomFieldValues_Overlay.pm
new file mode 100644 (file)
index 0000000..315c16f
--- /dev/null
+++ b/rt/lib/RT/ObjectCustomFieldValues_Overlay.pm
@@ -0,0 +1,153 @@
+# BEGIN BPS TAGGED BLOCK {{{
+# 
+# COPYRIGHT:
+#  
+# This software is Copyright (c) 1996-2005 Best Practical Solutions, LLC 
+#                                          <jesse@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., 675 Mass Ave, Cambridge, MA 02139, USA.
+# 
+# 
+# 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 }}}
+package RT::ObjectCustomFieldValues;
+
+use strict;
+no warnings qw(redefine);
+
+# {{{ sub LimitToCustomField
+
+=head2 LimitToCustomField FIELD
+
+Limits the returned set to values for the custom field with Id FIELD
+
+=cut
+  
+sub LimitToCustomField {
+    my $self = shift;
+    my $cf = shift;
+    return ($self->Limit( FIELD => 'CustomField',
+                         VALUE => $cf,
+                         OPERATOR => '='));
+
+}
+
+# }}}
+
+# {{{ sub LimitToTicket
+
+=head2 LimitToTicket TICKETID
+
+Limits the returned set to values for the ticket with Id TICKETID
+
+=cut
+  
+sub LimitToTicket {
+    my $self = shift;
+    my $ticket = shift;
+
+
+    $RT::Logger->warning(ref($self) . " -> LimitToTicket deprecated in favor of LimitToObject");
+
+    $self->Limit( FIELD => 'ObjectType',
+                 VALUE => 'RT::Ticket',
+                 OPERATOR => '=');
+    return ($self->Limit( FIELD => 'ObjectId',
+                         VALUE => $ticket,
+                         OPERATOR => '='));
+
+}
+
+# }}}
+
+
+sub LimitToObject {
+    my $self = shift;
+    my $object = shift;
+    $self->Limit( FIELD => 'ObjectType',
+                 VALUE => ref($object),
+                 OPERATOR => '=');
+    return ($self->Limit( FIELD => 'ObjectId',
+                         VALUE => $object->Id,
+                         OPERATOR => '='));
+
+}
+
+=sub HasEntry VALUE
+
+Returns true if this CustomFieldValues collection has an entry with content that eq VALUE
+
+=cut
+
+
+sub HasEntry {
+    my $self = shift;
+    my $value = shift;
+
+    #TODO: this could cache and optimize a fair bit.
+    foreach my $item (@{$self->ItemsArrayRef}) {
+        return(1) if ($item->Content eq $value);  
+    }
+    return undef;
+
+}
+
+sub _DoSearch {
+    my $self = shift;
+    
+    #unless we really want to find disabled rows, make sure we\'re only finding enabled ones.
+    unless($self->{'find_expired_rows'}) {
+        $self->LimitToEnabled();
+    }
+    
+    return($self->SUPER::_DoSearch(@_));
+    
+}
+
+sub _DoCount {
+    my $self = shift;
+    
+    #unless we really want to find disabled rows, make sure we\'re only finding enabled ones.
+    unless($self->{'find_expired_rows'}) {
+        $self->LimitToEnabled();
+    }
+    
+    return($self->SUPER::_DoCount(@_));
+    
+}
+
+1;
+