Merge branch 'master' of git.freeside.biz:/home/git/freeside
[freeside.git] / rt / lib / RT / ObjectCustomFieldValues.pm
index adf4829..527ce7b 100644 (file)
@@ -1,40 +1,40 @@
 # BEGIN BPS TAGGED BLOCK {{{
-# 
+#
 # COPYRIGHT:
-#  
-# This software is Copyright (c) 1996-2009 Best Practical Solutions, LLC 
-#                                          <jesse@bestpractical.com>
-# 
+#
+# 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
 # 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 }}}
-# 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 !!
 #
+# END BPS TAGGED BLOCK }}}
 
-use strict;
-
-
-=head1 NAME
-
-  RT::ObjectCustomFieldValues -- Class Description
-=head1 SYNOPSIS
-
-  use RT::ObjectCustomFieldValues
-
-=head1 DESCRIPTION
-
-
-=head1 METHODS
+package RT::ObjectCustomFieldValues;
 
-=cut
+use strict;
+use warnings;
 
-package RT::ObjectCustomFieldValues;
+use base 'RT::SearchBuilder';
 
-use RT::SearchBuilder;
 use RT::ObjectCustomFieldValue;
 
-use vars qw( @ISA );
-@ISA= qw(RT::SearchBuilder);
-
+sub Table { 'ObjectCustomFieldValues'}
 
 sub _Init {
     my $self = shift;
-    $self->{'table'} = 'ObjectCustomFieldValues';
-    $self->{'primary_key'} = 'id';
-
-
 
   # By default, order by SortOrder
   $self->OrderByCols(
-        { ALIAS => 'main',
-          FIELD => 'SortOrder',
-          ORDER => 'ASC' },
-        { ALIAS => 'main',
-          FIELD => 'id',
-          ORDER => 'ASC' },
+         { ALIAS => 'main',
+           FIELD => 'SortOrder',
+           ORDER => 'ASC' },
+         { ALIAS => 'main',
+           FIELD => 'id',
+           ORDER => 'ASC' },
      );
 
     return ( $self->SUPER::_Init(@_) );
 }
 
 
-=head2 NewItem
+# {{{ sub LimitToCustomField
 
-Returns an empty new RT::ObjectCustomFieldValue item
+=head2 LimitToCustomField FIELD
 
-=cut
+Limits the returned set to values for the custom field with Id FIELD
 
-sub NewItem {
+=cut
+  
+sub LimitToCustomField {
     my $self = shift;
-    return(RT::ObjectCustomFieldValue->new($self->CurrentUser));
+    my $cf = shift;
+    return $self->Limit(
+        FIELD => 'CustomField',
+        VALUE => $cf,
+    );
 }
 
-        eval "require RT::ObjectCustomFieldValues_Overlay";
-        if ($@ && $@ !~ qr{^Can't locate RT/ObjectCustomFieldValues_Overlay.pm}) {
-            die $@;
-        };
 
-        eval "require RT::ObjectCustomFieldValues_Vendor";
-        if ($@ && $@ !~ qr{^Can't locate RT/ObjectCustomFieldValues_Vendor.pm}) {
-            die $@;
-        };
 
-        eval "require RT::ObjectCustomFieldValues_Local";
-        if ($@ && $@ !~ qr{^Can't locate RT/ObjectCustomFieldValues_Local.pm}) {
-            die $@;
-        };
+=head2 LimitToObject OBJECT
 
+Limits the returned set to values for the given OBJECT
 
+=cut
 
+sub LimitToObject {
+    my $self = shift;
+    my $object = shift;
+    $self->Limit(
+        FIELD => 'ObjectType',
+        VALUE => ref($object),
+    );
+    return $self->Limit(
+        FIELD => 'ObjectId',
+        VALUE => $object->Id,
+    );
 
-=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.  
 
-These overlay files can contain new subs or subs to replace existing subs in this module.
+=head2 HasEntry CONTENT LARGE_CONTENT
 
-Each of these files should begin with the line 
+If this collection has an entry with content that eq CONTENT and large content
+that eq LARGE_CONTENT then returns the entry, otherwise returns undef.
 
-   no warnings qw(redefine);
+=cut
 
-so that perl does not kick and scream when you redefine a subroutine or variable in your overlay.
 
-RT::ObjectCustomFieldValues_Overlay, RT::ObjectCustomFieldValues_Vendor, RT::ObjectCustomFieldValues_Local
+sub HasEntry {
+    my $self = shift;
+    my $value = shift;
+    my $large_content = shift;
+    return undef unless defined $value && length $value;
+
+    my %canon_value;
+    #TODO: this could cache and optimize a fair bit.
+    foreach my $item ( @{$self->ItemsArrayRef} ) {
+        my $cf = $item->CustomFieldObj;
+        my $args = $canon_value{ $cf->Type };
+        if ( !$args ) {
+            $args = { Content => $value, LargeContent => $large_content };
+            my ($ok, $msg) = $cf->_CanonicalizeValue( $args );
+            next unless $ok;
+            $canon_value{ $cf->Type } = $args;
+        }
+
+        if ( $cf->Type eq 'Select' ) {
+            # select is case insensitive
+            return $item if lc $item->Content eq lc $args->{Content};
+        }
+        else {
+            if ( ($item->_Value('Content') || '') eq $args->{Content} ) {
+                if ( defined $item->LargeContent ) {
+                    return $item
+                      if defined $args->{LargeContent}
+                      && $item->LargeContent eq $args->{LargeContent};
+                }
+                else {
+                    return $item unless defined $args->{LargeContent};
+                }
+            } elsif ( $item->LargeContent && $args->{Content} ) {
+                return $item if ($item->LargeContent eq $args->{Content});
+            }
+        }
+    }
+    return undef;
+}
 
-=cut
+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(@_);
+}
 
+RT::Base->_ImportOverlays();
 
 1;