-# BEGIN LICENSE BLOCK
-#
-# Copyright (c) 1996-2003 Jesse Vincent <jesse@bestpractical.com>
-#
-# (Except where explictly superceded by other copyright notices)
-#
+# 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.
-#
-# Unless otherwise specified, all modifications, corrections or
-# extensions to this work which alter its source code become the
-# property of Best Practical Solutions, LLC when submitted for
-# inclusion in the work.
-#
-#
-# END LICENSE 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 !!
#
+# 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 }}}
-use strict;
-
-
-=head1 NAME
-
- RT::CustomFieldValues -- Class Description
-
-=head1 SYNOPSIS
-
- use RT::CustomFieldValues
-
-=head1 DESCRIPTION
-
-
-=head1 METHODS
+package RT::CustomFieldValues;
-=cut
+use strict;
+use warnings;
-package RT::CustomFieldValues;
+use base 'RT::SearchBuilder';
-use RT::SearchBuilder;
use RT::CustomFieldValue;
-use vars qw( @ISA );
-@ISA= qw(RT::SearchBuilder);
-
+sub Table { 'CustomFieldValues'}
sub _Init {
my $self = shift;
- $self->{'table'} = 'CustomFieldValues';
- $self->{'primary_key'} = 'id';
-
-
- # By default, order by name
- $self->OrderBy( ALIAS => 'main',
- FIELD => 'SortOrder',
- ORDER => 'ASC');
+ # By default, order by SortOrder
+ $self->OrderByCols(
+ { ALIAS => 'main',
+ FIELD => 'SortOrder',
+ ORDER => 'ASC' },
+ { ALIAS => 'main',
+ FIELD => 'Name',
+ ORDER => 'ASC' },
+ { ALIAS => 'main',
+ FIELD => 'id',
+ ORDER => 'ASC' },
+ );
return ( $self->SUPER::_Init(@_) );
}
+# {{{ sub LimitToCustomField
+=head2 LimitToCustomField FIELD
-=item NewItem
-
-Returns an empty new RT::CustomFieldValue item
+Limits the returned set to values for the custom field with Id FIELD
=cut
-
-sub NewItem {
+
+sub LimitToCustomField {
my $self = shift;
- return(RT::CustomFieldValue->new($self->CurrentUser));
+ my $cf = shift;
+ return $self->Limit(
+ FIELD => 'CustomField',
+ VALUE => $cf,
+ OPERATOR => '=',
+ );
}
- eval "require RT::CustomFieldValues_Overlay";
- if ($@ && $@ !~ qr{^Can't locate RT/CustomFieldValues_Overlay.pm}) {
- die $@;
- };
+=head2 SetCustomFieldObject
+
+Store the CustomField object which loaded this CustomFieldValues collection.
+Consumers of CustomFieldValues collection (such as External Custom Fields)
+can now work out how they were loaded (off a Queue or Ticket or something else)
+by inspecting the CustomField.
- eval "require RT::CustomFieldValues_Vendor";
- if ($@ && $@ !~ qr{^Can't locate RT/CustomFieldValues_Vendor.pm}) {
- die $@;
- };
+=cut
- eval "require RT::CustomFieldValues_Local";
- if ($@ && $@ !~ qr{^Can't locate RT/CustomFieldValues_Local.pm}) {
- die $@;
- };
+sub SetCustomFieldObject {
+ my $self = shift;
+ return $self->{'custom_field'} = shift;
+}
+=head2 CustomFieldObject
+Returns the CustomField object used to load this CustomFieldValues collection.
+Relies on $CustomField->Values having been called, is not set on manual loads.
+=cut
-=head1 SEE ALSO
+sub CustomFieldObject {
+ my $self = shift;
+ return $self->{'custom_field'};
+}
-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.
+=head2 AddRecord
-These overlay files can contain new subs or subs to replace existing subs in this module.
+Propagates the CustomField object from the Collection
+down to individual CustomFieldValue objects.
-If you'll be working with perl 5.6.0 or greater, each of these files should begin with the line
+=cut
- no warnings qw(redefine);
+sub AddRecord {
+ my $self = shift;
+ my $CFV = shift;
-so that perl does not kick and scream when you redefine a subroutine or variable in your overlay.
+ $CFV->SetCustomFieldObj($self->CustomFieldObject);
-RT::CustomFieldValues_Overlay, RT::CustomFieldValues_Vendor, RT::CustomFieldValues_Local
+ push @{$self->{'items'}}, $CFV;
+ $self->{'rows'}++;
+}
-=cut
+RT::Base->_ImportOverlays();
1;