rt/lib/RT/ObjectCustomFieldValues.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2012 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
  55 use RT::ObjectCustomFieldValue;
  56
  57 use base 'RT::SearchBuilder';
  58
  59 sub Table { 'ObjectCustomFieldValues'}
  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
  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     );
  93 }
  94
  95
  96
  97 =head2 LimitToObject OBJECT
  98
  99 Limits the returned set to values for the given OBJECT
 100
 101 =cut
 102
 103 sub LimitToObject {
 104     my $self = shift;
 105     my $object = shift;
 106     $self->Limit(
 107         FIELD => 'ObjectType',
 108         VALUE => ref($object),
 109     );
 110     return $self->Limit(
 111         FIELD => 'ObjectId',
 112         VALUE => $object->Id,
 113     );
 114
 115 }
 116
 117
 118 =head2 HasEntry VALUE
 119
 120 If this collection has an entry with content that eq VALUE then
 121 returns the entry, otherwise returns undef.
 122
 123 =cut
 124
 125
 126 sub HasEntry {
 127     my $self = shift;
 128     my $value = shift;
 129     return undef unless defined $value && length $value;
 130
 131     #TODO: this could cache and optimize a fair bit.
 132     foreach my $item ( @{$self->ItemsArrayRef} ) {
 133         return $item if lc $item->Content eq lc $value;
 134     }
 135     return undef;
 136 }
 137
 138 sub _DoSearch {
 139     my $self = shift;
 140
 141     # unless we really want to find disabled rows,
 142     # make sure we\'re only finding enabled ones.
 143     unless ( $self->{'find_expired_rows'} ) {
 144         $self->LimitToEnabled();
 145     }
 146
 147     return $self->SUPER::_DoSearch(@_);
 148 }
 149
 150 sub _DoCount {
 151     my $self = shift;
 152
 153     # unless we really want to find disabled rows,
 154     # make sure we\'re only finding enabled ones.
 155     unless ( $self->{'find_expired_rows'} ) {
 156         $self->LimitToEnabled();
 157     }
 158
 159     return $self->SUPER::_DoCount(@_);
 160 }
 161
 162
 163 =head2 NewItem
 164
 165 Returns an empty new RT::ObjectCustomFieldValue item
 166
 167 =cut
 168
 169 sub NewItem {
 170     my $self = shift;
 171     return(RT::ObjectCustomFieldValue->new($self->CurrentUser));
 172 }
 173 RT::Base->_ImportOverlays();
 174
 175 1;