rt/lib/RT/ObjectCustomFieldValues_Overlay.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2005 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., 675 Mass Ave, Cambridge, MA 02139, USA.
  26 #
  27 #
  28 # CONTRIBUTION SUBMISSION POLICY:
  29 #
  30 # (The following paragraph is not intended to limit the rights granted
  31 # to you to modify and distribute this software under the terms of
  32 # the GNU General Public License and is only of importance to you if
  33 # you choose to contribute your changes and enhancements to the
  34 # community by submitting them to Best Practical Solutions, LLC.)
  35 #
  36 # By intentionally submitting any modifications, corrections or
  37 # derivatives to this work, or any other work intended for use with
  38 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
  39 # you are the copyright holder for those contributions and you grant
  40 # Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
  41 # royalty-free, perpetual, license to use, copy, create derivative
  42 # works based on those contributions, and sublicense and distribute
  43 # those contributions and any derivatives thereof.
  44 #
  45 # END BPS TAGGED BLOCK }}}
  46 package RT::ObjectCustomFieldValues;
  47
  48 use strict;
  49 no warnings qw(redefine);
  50
  51 # {{{ sub LimitToCustomField
  52
  53 =head2 LimitToCustomField FIELD
  54
  55 Limits the returned set to values for the custom field with Id FIELD
  56
  57 =cut
  58
  59 sub LimitToCustomField {
  60     my $self = shift;
  61     my $cf = shift;
  62     return ($self->Limit( FIELD => 'CustomField',
  63                           VALUE => $cf,
  64                           OPERATOR => '='));
  65
  66 }
  67
  68 # }}}
  69
  70 # {{{ sub LimitToTicket
  71
  72 =head2 LimitToTicket TICKETID
  73
  74 Limits the returned set to values for the ticket with Id TICKETID
  75
  76 =cut
  77
  78 sub LimitToTicket {
  79     my $self = shift;
  80     my $ticket = shift;
  81
  82
  83     $RT::Logger->warning(ref($self) . " -> LimitToTicket deprecated in favor of LimitToObject");
  84
  85     $self->Limit( FIELD => 'ObjectType',
  86                   VALUE => 'RT::Ticket',
  87                   OPERATOR => '=');
  88     return ($self->Limit( FIELD => 'ObjectId',
  89                           VALUE => $ticket,
  90                           OPERATOR => '='));
  91
  92 }
  93
  94 # }}}
  95
  96
  97 sub LimitToObject {
  98     my $self = shift;
  99     my $object = shift;
 100     $self->Limit( FIELD => 'ObjectType',
 101                   VALUE => ref($object),
 102                   OPERATOR => '=');
 103     return ($self->Limit( FIELD => 'ObjectId',
 104                           VALUE => $object->Id,
 105                           OPERATOR => '='));
 106
 107 }
 108
 109 =sub HasEntry VALUE
 110
 111 Returns true if this CustomFieldValues collection has an entry with content that eq VALUE
 112
 113 =cut
 114
 115
 116 sub HasEntry {
 117     my $self = shift;
 118     my $value = shift;
 119
 120     #TODO: this could cache and optimize a fair bit.
 121     foreach my $item (@{$self->ItemsArrayRef}) {
 122         return(1) if ($item->Content eq $value);
 123     }
 124     return undef;
 125
 126 }
 127
 128 sub _DoSearch {
 129     my $self = shift;
 130
 131     #unless we really want to find disabled rows, make sure we\'re only finding enabled ones.
 132     unless($self->{'find_expired_rows'}) {
 133         $self->LimitToEnabled();
 134     }
 135
 136     return($self->SUPER::_DoSearch(@_));
 137
 138 }
 139
 140 sub _DoCount {
 141     my $self = shift;
 142
 143     #unless we really want to find disabled rows, make sure we\'re only finding enabled ones.
 144     unless($self->{'find_expired_rows'}) {
 145         $self->LimitToEnabled();
 146     }
 147
 148     return($self->SUPER::_DoCount(@_));
 149
 150 }
 151
 152 1;
 153