rt/lib/RT/Queues_Overlay.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2007 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/copyleft/gpl.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 =head1 NAME
  49
  50   RT::Queues - a collection of RT::Queue objects
  51
  52 =head1 SYNOPSIS
  53
  54   use RT::Queues;
  55
  56 =head1 DESCRIPTION
  57
  58
  59 =head1 METHODS
  60
  61
  62 =begin testing
  63
  64 ok (require RT::Queues);
  65
  66 =end testing
  67
  68 =cut
  69
  70
  71 package RT::Queues;
  72
  73 use strict;
  74 no warnings qw(redefine);
  75
  76 # {{{ sub _Init
  77 sub _Init {
  78   my $self = shift;
  79   $self->{'table'} = "Queues";
  80   $self->{'primary_key'} = "id";
  81
  82   # By default, order by name
  83   $self->OrderBy( ALIAS => 'main',
  84                   FIELD => 'Name',
  85                   ORDER => 'ASC');
  86
  87   return ($self->SUPER::_Init(@_));
  88 }
  89 # }}}
  90
  91 # {{{ sub _DoSearch
  92
  93 =head2 _DoSearch
  94
  95   A subclass of DBIx::SearchBuilder::_DoSearch that makes sure that _Disabled rows never get seen unless
  96 we're explicitly trying to see them.
  97
  98 =cut
  99
 100 sub _DoSearch {
 101     my $self = shift;
 102
 103     #unless we really want to find disabled rows, make sure we\'re only finding enabled ones.
 104     unless($self->{'find_disabled_rows'}) {
 105         $self->LimitToEnabled();
 106     }
 107
 108     return($self->SUPER::_DoSearch(@_));
 109
 110 }
 111
 112 # }}}
 113
 114
 115 # {{{ sub Limit
 116 sub Limit  {
 117   my $self = shift;
 118   my %args = ( ENTRYAGGREGATOR => 'AND',
 119                @_);
 120   $self->SUPER::Limit(%args);
 121 }
 122 # }}}
 123
 124 # {{{ sub AddRecord
 125
 126 =head2 AddRecord
 127
 128 Adds a record object to this collection if this user can see.
 129 This is used for filtering objects for both Next and ItemsArrayRef.
 130
 131 =cut
 132
 133 sub AddRecord {
 134     my $self = shift;
 135     my $Queue = shift;
 136     return unless $Queue->CurrentUserHasRight('SeeQueue');
 137
 138     push @{$self->{'items'}}, $Queue;
 139     $self->{'rows'}++;
 140 }
 141 # }}}
 142
 143 1;
 144