rt/lib/RT/Queues_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
  47 =head1 NAME
  48
  49   RT::Queues - a collection of RT::Queue objects
  50
  51 =head1 SYNOPSIS
  52
  53   use RT::Queues;
  54
  55 =head1 DESCRIPTION
  56
  57
  58 =head1 METHODS
  59
  60
  61 =begin testing
  62
  63 ok (require RT::Queues);
  64
  65 =end testing
  66
  67 =cut
  68
  69
  70 package RT::Queues;
  71
  72 use strict;
  73 no warnings qw(redefine);
  74
  75 # {{{ sub _Init
  76 sub _Init {
  77   my $self = shift;
  78   $self->{'table'} = "Queues";
  79   $self->{'primary_key'} = "id";
  80
  81   # By default, order by name
  82   $self->OrderBy( ALIAS => 'main',
  83                   FIELD => 'Name',
  84                   ORDER => 'ASC');
  85
  86   return ($self->SUPER::_Init(@_));
  87 }
  88 # }}}
  89
  90 # {{{ sub _DoSearch
  91
  92 =head2 _DoSearch
  93
  94   A subclass of DBIx::SearchBuilder::_DoSearch that makes sure that _Disabled rows never get seen unless
  95 we're explicitly trying to see them.
  96
  97 =cut
  98
  99 sub _DoSearch {
 100     my $self = shift;
 101
 102     #unless we really want to find disabled rows, make sure we\'re only finding enabled ones.
 103     unless($self->{'find_disabled_rows'}) {
 104         $self->LimitToEnabled();
 105     }
 106
 107     return($self->SUPER::_DoSearch(@_));
 108
 109 }
 110
 111 # }}}
 112
 113
 114 # {{{ sub Limit
 115 sub Limit  {
 116   my $self = shift;
 117   my %args = ( ENTRYAGGREGATOR => 'AND',
 118                @_);
 119   $self->SUPER::Limit(%args);
 120 }
 121 # }}}
 122
 123 # {{{ sub Next
 124
 125 =head2 Next
 126
 127 Returns the next queue that this user can see.
 128
 129 =cut
 130
 131 sub Next {
 132     my $self = shift;
 133
 134
 135     my $Queue = $self->SUPER::Next();
 136     if ((defined($Queue)) and (ref($Queue))) {
 137
 138         if ($Queue->CurrentUserHasRight('SeeQueue')) {
 139             return($Queue);
 140         }
 141
 142         #If the user doesn't have the right to show this queue
 143         else {
 144             return($self->Next());
 145         }
 146     }
 147     #if there never was any queue
 148     else {
 149         return(undef);
 150     }
 151
 152 }
 153 # }}}
 154
 155 1;
 156