rt 4.0.23
[freeside.git] / rt / lib / RT / ObjectCustomFields.pm
index fcbf332..1a488aa 100644 (file)
@@ -1,38 +1,40 @@
 # BEGIN BPS TAGGED BLOCK {{{
-# 
+#
 # COPYRIGHT:
-#  
-# This software is Copyright (c) 1996-2005 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., 675 Mass Ave, Cambridge, MA 02139, USA.
-# 
-# 
+# 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::ObjectCustomFields -- Class Description
-=head1 SYNOPSIS
-
-  use RT::ObjectCustomFields
-
-=head1 DESCRIPTION
-
-
-=head1 METHODS
+package RT::ObjectCustomFields;
 
-=cut
+use strict;
+use warnings;
 
-package RT::ObjectCustomFields;
 
-use RT::SearchBuilder;
 use RT::ObjectCustomField;
 
-use vars qw( @ISA );
-@ISA= qw(RT::SearchBuilder);
+use base 'RT::SearchBuilder';
 
+sub Table { 'ObjectCustomFields'}
 
 sub _Init {
     my $self = shift;
-    $self->{'table'} = 'ObjectCustomFields';
-    $self->{'primary_key'} = 'id';
-
-
 
   # By default, order by SortOrder
   $self->OrderByCols(
@@ -97,52 +75,81 @@ sub _Init {
 }
 
 
-=head2 NewItem
-
-Returns an empty new RT::ObjectCustomField item
-
-=cut
-
-sub NewItem {
+sub LimitToCustomField {
     my $self = shift;
-    return(RT::ObjectCustomField->new($self->CurrentUser));
+    my $id = shift;
+    $self->Limit( FIELD => 'CustomField', VALUE => $id );
 }
 
-        eval "require RT::ObjectCustomFields_Overlay";
-        if ($@ && $@ !~ qr{^Can't locate RT/ObjectCustomFields_Overlay.pm}) {
-            die $@;
-        };
-
-        eval "require RT::ObjectCustomFields_Vendor";
-        if ($@ && $@ !~ qr{^Can't locate RT/ObjectCustomFields_Vendor.pm}) {
-            die $@;
-        };
-
-        eval "require RT::ObjectCustomFields_Local";
-        if ($@ && $@ !~ qr{^Can't locate RT/ObjectCustomFields_Local.pm}) {
-            die $@;
-        };
-
-
-
+sub LimitToObjectId {
+    my $self = shift;
+    my $id = shift || 0;
+    $self->Limit( FIELD => 'ObjectId', VALUE => $id );
+}
 
-=head1 SEE ALSO
+sub LimitToLookupType {
+    my $self = shift;
+    my $lookup = shift;
+
+    $self->{'_cfs_alias'} ||= $self->Join(
+        ALIAS1 => 'main',
+        FIELD1 => 'CustomField',
+        TABLE2 => 'CustomFields',
+        FIELD2 => 'id',
+    );
+    $self->Limit(
+        ALIAS    => $self->{'_cfs_alias'},
+        FIELD    => 'LookupType',
+        OPERATOR => '=',
+        VALUE    => $lookup,
+    );
+}
 
-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.  
+sub HasEntryForCustomField {
+    my $self = shift;
+    my $id = shift;
+
+    my @items = grep {$_->CustomField == $id } @{$self->ItemsArrayRef};
+
+    if ($#items > 1) {
+       die "$self HasEntry had a list with more than one of $id in it. this can never happen";
+    }
+    if ($#items == -1 ) {
+       return undef;
+    }
+    else {
+       return ($items[0]);
+    }  
+}
 
-These overlay files can contain new subs or subs to replace existing subs in this module.
+sub CustomFields {
+    my $self = shift;
+    my %seen;
+    map { $_->CustomFieldObj } @{$self->ItemsArrayRef};
+}
 
-Each of these files should begin with the line 
+sub _DoSearch {
+    my $self = shift;
+    if ($self->{'_cfs_alias'}) {
+    $self->Limit( ALIAS           => $self->{'_cfs_alias'},
+                 FIELD           => 'Disabled',
+                 OPERATOR        => '!=',
+                 VALUE           =>  1);
+    }
+    $self->SUPER::_DoSearch()
+}
 
-   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::ObjectCustomFields_Overlay, RT::ObjectCustomFields_Vendor, RT::ObjectCustomFields_Local
+Returns an empty new RT::ObjectCustomField item
 
 =cut
 
+sub NewItem {
+    my $self = shift;
+    return(RT::ObjectCustomField->new($self->CurrentUser));
+}
+RT::Base->_ImportOverlays();
 
 1;