rt/lib/RT/Queues_Overlay.pm

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