lib/RT/ObjectCustomFieldValues.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::ObjectCustomFieldValues;
  50
  51 use strict;
  52 use warnings;
  53
  54 use base 'RT::SearchBuilder';
  55
  56 use RT::ObjectCustomFieldValue;
  57
  58 sub Table { 'ObjectCustomFieldValues'}
  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 => 'id',
  70            ORDER => 'ASC' },
  71      );
  72
  73     return ( $self->SUPER::_Init(@_) );
  74 }
  75
  76
  77 # {{{ sub LimitToCustomField
  78
  79 =head2 LimitToCustomField FIELD
  80
  81 Limits the returned set to values for the custom field with Id FIELD
  82
  83 =cut
  84
  85 sub LimitToCustomField {
  86     my $self = shift;
  87     my $cf = shift;
  88     return $self->Limit(
  89         FIELD => 'CustomField',
  90         VALUE => $cf,
  91     );
  92 }
  93
  94
  95
  96 =head2 LimitToObject OBJECT
  97
  98 Limits the returned set to values for the given OBJECT
  99
 100 =cut
 101
 102 sub LimitToObject {
 103     my $self = shift;
 104     my $object = shift;
 105     $self->Limit(
 106         FIELD => 'ObjectType',
 107         VALUE => ref($object),
 108     );
 109     return $self->Limit(
 110         FIELD => 'ObjectId',
 111         VALUE => $object->Id,
 112     );
 113
 114 }
 115
 116
 117 =head2 HasEntry CONTENT LARGE_CONTENT
 118
 119 If this collection has an entry with content that eq CONTENT and large content
 120 that eq LARGE_CONTENT then returns the entry, otherwise returns undef.
 121
 122 =cut
 123
 124
 125 sub HasEntry {
 126     my $self = shift;
 127     my $value = shift;
 128     my $large_content = shift;
 129     return undef unless defined $value && length $value;
 130
 131     my %canon_value;
 132     #TODO: this could cache and optimize a fair bit.
 133     foreach my $item ( @{$self->ItemsArrayRef} ) {
 134         my $cf = $item->CustomFieldObj;
 135         my $args = $canon_value{ $cf->Type };
 136         if ( !$args ) {
 137             $args = { Content => $value, LargeContent => $large_content };
 138             my ($ok, $msg) = $cf->_CanonicalizeValue( $args );
 139             next unless $ok;
 140             $canon_value{ $cf->Type } = $args;
 141         }
 142
 143         if ( $cf->Type eq 'Select' ) {
 144             # select is case insensitive
 145             return $item if lc $item->Content eq lc $args->{Content};
 146         }
 147         else {
 148             if ( $item->_Value('Content') eq $args->{Content} ) {
 149                 if ( defined $item->LargeContent ) {
 150                     return $item
 151                       if defined $args->{LargeContent}
 152                       && $item->LargeContent eq $args->{LargeContent};
 153                 }
 154                 else {
 155                     return $item unless defined $args->{LargeContent};
 156                 }
 157             }
 158         }
 159     }
 160     return undef;
 161 }
 162
 163 sub _DoSearch {
 164     my $self = shift;
 165
 166     # unless we really want to find disabled rows,
 167     # make sure we're only finding enabled ones.
 168     unless ( $self->{'find_expired_rows'} ) {
 169         $self->LimitToEnabled();
 170     }
 171
 172     return $self->SUPER::_DoSearch(@_);
 173 }
 174
 175 sub _DoCount {
 176     my $self = shift;
 177
 178     # unless we really want to find disabled rows,
 179     # make sure we're only finding enabled ones.
 180     unless ( $self->{'find_expired_rows'} ) {
 181         $self->LimitToEnabled();
 182     }
 183
 184     return $self->SUPER::_DoCount(@_);
 185 }
 186
 187 RT::Base->_ImportOverlays();
 188
 189 1;