rt/lib/RT/ObjectCustomFieldValues_Overlay.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2009 Best Practical Solutions, LLC
   6 #                                          <jesse@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 no warnings qw(redefine);
  53
  54 # {{{ sub LimitToCustomField
  55
  56 =head2 LimitToCustomField FIELD
  57
  58 Limits the returned set to values for the custom field with Id FIELD
  59
  60 =cut
  61
  62 sub LimitToCustomField {
  63     my $self = shift;
  64     my $cf = shift;
  65     return $self->Limit(
  66         FIELD => 'CustomField',
  67         VALUE => $cf,
  68     );
  69 }
  70
  71 # }}}
  72
  73 # {{{ sub LimitToObject
  74
  75 =head2 LimitToObject OBJECT
  76
  77 Limits the returned set to values for the given OBJECT
  78
  79 =cut
  80
  81 sub LimitToObject {
  82     my $self = shift;
  83     my $object = shift;
  84     $self->Limit(
  85         FIELD => 'ObjectType',
  86         VALUE => ref($object),
  87     );
  88     return $self->Limit(
  89         FIELD => 'ObjectId',
  90         VALUE => $object->Id,
  91     );
  92
  93 }
  94
  95 # }}}
  96
  97 =head2 HasEntry VALUE
  98
  99 If this collection has an entry with content that eq VALUE then
 100 returns the entry, otherwise returns undef.
 101
 102 =cut
 103
 104
 105 sub HasEntry {
 106     my $self = shift;
 107     my $value = shift;
 108     return undef unless defined $value && length $value;
 109
 110     #TODO: this could cache and optimize a fair bit.
 111     foreach my $item ( @{$self->ItemsArrayRef} ) {
 112         return $item if lc $item->Content eq lc $value;
 113     }
 114     return undef;
 115 }
 116
 117 sub _DoSearch {
 118     my $self = shift;
 119
 120     # unless we really want to find disabled rows,
 121     # make sure we\'re only finding enabled ones.
 122     unless ( $self->{'find_expired_rows'} ) {
 123         $self->LimitToEnabled();
 124     }
 125
 126     return $self->SUPER::_DoSearch(@_);
 127 }
 128
 129 sub _DoCount {
 130     my $self = shift;
 131
 132     # unless we really want to find disabled rows,
 133     # make sure we\'re only finding enabled ones.
 134     unless ( $self->{'find_expired_rows'} ) {
 135         $self->LimitToEnabled();
 136     }
 137
 138     return $self->SUPER::_DoCount(@_);
 139 }
 140
 141 1;
 142