rt/lib/RT/ObjectCustomFields.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2014 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::ObjectCustomFields;
  50
  51 use strict;
  52 use warnings;
  53
  54
  55 use RT::ObjectCustomField;
  56
  57 use base 'RT::SearchBuilder';
  58
  59 sub Table { 'ObjectCustomFields'}
  60
  61 sub _Init {
  62     my $self = shift;
  63
  64   # By default, order by SortOrder
  65   $self->OrderByCols(
  66          { ALIAS => 'main',
  67            FIELD => 'SortOrder',
  68            ORDER => 'ASC' },
  69          { ALIAS => 'main',
  70            FIELD => 'id',
  71            ORDER => 'ASC' },
  72      );
  73
  74     return ( $self->SUPER::_Init(@_) );
  75 }
  76
  77
  78 sub LimitToCustomField {
  79     my $self = shift;
  80     my $id = shift;
  81     $self->Limit( FIELD => 'CustomField', VALUE => $id );
  82 }
  83
  84 sub LimitToObjectId {
  85     my $self = shift;
  86     my $id = shift || 0;
  87     $self->Limit( FIELD => 'ObjectId', VALUE => $id );
  88 }
  89
  90 sub LimitToLookupType {
  91     my $self = shift;
  92     my $lookup = shift;
  93
  94     $self->{'_cfs_alias'} ||= $self->Join(
  95         ALIAS1 => 'main',
  96         FIELD1 => 'CustomField',
  97         TABLE2 => 'CustomFields',
  98         FIELD2 => 'id',
  99     );
 100     $self->Limit(
 101         ALIAS    => $self->{'_cfs_alias'},
 102         FIELD    => 'LookupType',
 103         OPERATOR => '=',
 104         VALUE    => $lookup,
 105     );
 106 }
 107
 108 sub HasEntryForCustomField {
 109     my $self = shift;
 110     my $id = shift;
 111
 112     my @items = grep {$_->CustomField == $id } @{$self->ItemsArrayRef};
 113
 114     if ($#items > 1) {
 115         die "$self HasEntry had a list with more than one of $id in it. this can never happen";
 116     }
 117     if ($#items == -1 ) {
 118         return undef;
 119     }
 120     else {
 121         return ($items[0]);
 122     }
 123 }
 124
 125 sub CustomFields {
 126     my $self = shift;
 127     my %seen;
 128     map { $_->CustomFieldObj } @{$self->ItemsArrayRef};
 129 }
 130
 131 sub _DoSearch {
 132     my $self = shift;
 133     if ($self->{'_cfs_alias'}) {
 134     $self->Limit( ALIAS           => $self->{'_cfs_alias'},
 135                  FIELD           => 'Disabled',
 136                  OPERATOR        => '!=',
 137                  VALUE           =>  1);
 138     }
 139     $self->SUPER::_DoSearch()
 140 }
 141
 142
 143 =head2 NewItem
 144
 145 Returns an empty new RT::ObjectCustomField item
 146
 147 =cut
 148
 149 sub NewItem {
 150     my $self = shift;
 151     return(RT::ObjectCustomField->new($self->CurrentUser));
 152 }
 153 RT::Base->_ImportOverlays();
 154
 155 1;