rt/lib/RT/Queues_Overlay.pm

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