rt/lib/RT/CustomFieldValues.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2017 Best Practical Solutions, LLC
   6 #                                          <sales@bestpractical.com>
   7 #
   8 # (Except where explicitly superseded by other copyright notices)
   9 #
  10 #
  11 # LICENSE:
  12 #
  13 # This work is made available to you under the terms of Version 2 of
  14 # the GNU General Public License. A copy of that license should have
  15 # been provided with this software, but in any event can be snarfed
  16 # from www.gnu.org.
  17 #
  18 # This work is distributed in the hope that it will be useful, but
  19 # WITHOUT ANY WARRANTY; without even the implied warranty of
  20 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  21 # General Public License for more details.
  22 #
  23 # You should have received a copy of the GNU General Public License
  24 # along with this program; if not, write to the Free Software
  25 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  26 # 02110-1301 or visit their web page on the internet at
  27 # http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
  28 #
  29 #
  30 # CONTRIBUTION SUBMISSION POLICY:
  31 #
  32 # (The following paragraph is not intended to limit the rights granted
  33 # to you to modify and distribute this software under the terms of
  34 # the GNU General Public License and is only of importance to you if
  35 # you choose to contribute your changes and enhancements to the
  36 # community by submitting them to Best Practical Solutions, LLC.)
  37 #
  38 # By intentionally submitting any modifications, corrections or
  39 # derivatives to this work, or any other work intended for use with
  40 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
  41 # you are the copyright holder for those contributions and you grant
  42 # Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
  43 # royalty-free, perpetual, license to use, copy, create derivative
  44 # works based on those contributions, and sublicense and distribute
  45 # those contributions and any derivatives thereof.
  46 #
  47 # END BPS TAGGED BLOCK }}}
  48
  49 package RT::CustomFieldValues;
  50
  51 use strict;
  52 use warnings;
  53
  54 use base 'RT::SearchBuilder';
  55
  56 use RT::CustomFieldValue;
  57
  58 sub Table { 'CustomFieldValues'}
  59
  60 sub _Init {
  61     my $self = shift;
  62
  63   # By default, order by SortOrder
  64   $self->OrderByCols(
  65          { ALIAS => 'main',
  66            FIELD => 'SortOrder',
  67            ORDER => 'ASC' },
  68          { ALIAS => 'main',
  69            FIELD => 'Name',
  70            ORDER => 'ASC' },
  71          { ALIAS => 'main',
  72            FIELD => 'id',
  73            ORDER => 'ASC' },
  74      );
  75
  76     return ( $self->SUPER::_Init(@_) );
  77 }
  78 # {{{ sub LimitToCustomField
  79
  80 =head2 LimitToCustomField FIELD
  81
  82 Limits the returned set to values for the custom field with Id FIELD
  83
  84 =cut
  85
  86 sub LimitToCustomField {
  87     my $self = shift;
  88     my $cf = shift;
  89     return $self->Limit(
  90         FIELD    => 'CustomField',
  91         VALUE    => $cf,
  92         OPERATOR => '=',
  93     );
  94 }
  95
  96 =head2 SetCustomFieldObject
  97
  98 Store the CustomField object which loaded this CustomFieldValues collection.
  99 Consumers of CustomFieldValues collection (such as External Custom Fields)
 100 can now work out how they were loaded (off a Queue or Ticket or something else)
 101 by inspecting the CustomField.
 102
 103 =cut
 104
 105 sub SetCustomFieldObject {
 106     my $self = shift;
 107     return $self->{'custom_field'} = shift;
 108 }
 109
 110 =head2 CustomFieldObject
 111
 112 Returns the CustomField object used to load this CustomFieldValues collection.
 113 Relies on $CustomField->Values having been called, is not set on manual loads.
 114
 115 =cut
 116
 117 sub CustomFieldObject {
 118     my $self = shift;
 119     return $self->{'custom_field'};
 120 }
 121
 122 =head2 AddRecord
 123
 124 Propagates the CustomField object from the Collection
 125 down to individual CustomFieldValue objects.
 126
 127 =cut
 128
 129 sub AddRecord {
 130     my $self = shift;
 131     my $CFV = shift;
 132
 133     $CFV->SetCustomFieldObj($self->CustomFieldObject);
 134
 135     push @{$self->{'items'}}, $CFV;
 136     $self->{'rows'}++;
 137 }
 138
 139
 140 RT::Base->_ImportOverlays();
 141
 142 1;