rt 4.0.23
[freeside.git] / rt / lib / RT / Queues.pm
index e1be353..d6e5c76 100755 (executable)
@@ -1,38 +1,40 @@
-# {{{ BEGIN BPS TAGGED BLOCK
-# 
+# BEGIN BPS TAGGED BLOCK {{{
+#
 # COPYRIGHT:
-#  
-# This software is Copyright (c) 1996-2004 Best Practical Solutions, LLC 
-#                                          <jesse@bestpractical.com>
-# 
+#
+# This software is Copyright (c) 1996-2015 Best Practical Solutions, LLC
+#                                          <sales@bestpractical.com>
+#
 # (Except where explicitly superseded by other copyright notices)
-# 
-# 
+#
+#
 # LICENSE:
-# 
+#
 # This work is made available to you under the terms of Version 2 of
 # the GNU General Public License. A copy of that license should have
 # been provided with this software, but in any event can be snarfed
 # from www.gnu.org.
-# 
+#
 # This work is distributed in the hope that it will be useful, but
 # WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 # General Public License for more details.
-# 
+#
 # You should have received a copy of the GNU General Public License
 # along with this program; if not, write to the Free Software
-# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-# 
-# 
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+# 02110-1301 or visit their web page on the internet at
+# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
+#
+#
 # CONTRIBUTION SUBMISSION POLICY:
-# 
+#
 # (The following paragraph is not intended to limit the rights granted
 # to you to modify and distribute this software under the terms of
 # the GNU General Public License and is only of importance to you if
 # you choose to contribute your changes and enhancements to the
 # community by submitting them to Best Practical Solutions, LLC.)
-# 
+#
 # By intentionally submitting any modifications, corrections or
 # derivatives to this work, or any other work intended for use with
 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
 # royalty-free, perpetual, license to use, copy, create derivative
 # works based on those contributions, and sublicense and distribute
 # those contributions and any derivatives thereof.
-# 
-# }}} END BPS TAGGED BLOCK
-# Autogenerated by DBIx::SearchBuilder factory (by <jesse@bestpractical.com>)
-# WARNING: THIS FILE IS AUTOGENERATED. ALL CHANGES TO THIS FILE WILL BE LOST.  
-# 
-# !! DO NOT EDIT THIS FILE !!
 #
-
-use strict;
-
+# END BPS TAGGED BLOCK }}}
 
 =head1 NAME
 
-  RT::Queues -- Class Description
+  RT::Queues - a collection of RT::Queue objects
+
 =head1 SYNOPSIS
 
-  use RT::Queues
+  use RT::Queues;
 
 =head1 DESCRIPTION
 
 
 =head1 METHODS
 
-=cut
 
-package RT::Queues;
 
-use RT::SearchBuilder;
-use RT::Queue;
+=cut
 
-use vars qw( @ISA );
-@ISA= qw(RT::SearchBuilder);
 
+package RT::Queues;
 
-sub _Init {
-    my $self = shift;
-    $self->{'table'} = 'Queues';
-    $self->{'primary_key'} = 'id';
+use strict;
+use warnings;
 
 
-    return ( $self->SUPER::_Init(@_) );
-}
+use RT::Queue;
 
+use base 'RT::SearchBuilder';
 
-=head2 NewItem
+sub Table { 'Queues'}
 
-Returns an empty new RT::Queue item
+# {{{ sub _Init
+sub _Init { 
+  my $self = shift;
+  $self->{'with_disabled_column'} = 1;
 
-=cut
+  # By default, order by name
+  $self->OrderBy( ALIAS => 'main',
+                 FIELD => 'Name',
+                 ORDER => 'ASC');
 
-sub NewItem {
-    my $self = shift;
-    return(RT::Queue->new($self->CurrentUser));
+  return ($self->SUPER::_Init(@_));
 }
 
-        eval "require RT::Queues_Overlay";
-        if ($@ && $@ !~ qr{^Can't locate RT/Queues_Overlay.pm}) {
-            die $@;
-        };
-
-        eval "require RT::Queues_Vendor";
-        if ($@ && $@ !~ qr{^Can't locate RT/Queues_Vendor.pm}) {
-            die $@;
-        };
+sub Limit  {
+  my $self = shift;
+  my %args = ( ENTRYAGGREGATOR => 'AND',
+              @_);
+  $self->SUPER::Limit(%args);
+}
 
-        eval "require RT::Queues_Local";
-        if ($@ && $@ !~ qr{^Can't locate RT/Queues_Local.pm}) {
-            die $@;
-        };
 
+=head2 AddRecord
 
+Adds a record object to this collection if this user can see.
+This is used for filtering objects for both Next and ItemsArrayRef.
 
+=cut
 
-=head1 SEE ALSO
+sub AddRecord {
+    my $self = shift;
+    my $Queue = shift;
+    return unless $Queue->CurrentUserHasRight('SeeQueue');
 
-This class allows "overlay" methods to be placed
-into the following files _Overlay is for a System overlay by the original author,
-_Vendor is for 3rd-party vendor add-ons, while _Local is for site-local customizations.  
+    push @{$self->{'items'}}, $Queue;
+    $self->{'rows'}++;
+}
 
-These overlay files can contain new subs or subs to replace existing subs in this module.
 
-If you'll be working with perl 5.6.0 or greater, each of these files should begin with the line 
 
-   no warnings qw(redefine);
 
-so that perl does not kick and scream when you redefine a subroutine or variable in your overlay.
+=head2 NewItem
 
-RT::Queues_Overlay, RT::Queues_Vendor, RT::Queues_Local
+Returns an empty new RT::Queue item
 
 =cut
 
+sub NewItem {
+    my $self = shift;
+    return(RT::Queue->new($self->CurrentUser));
+}
+RT::Base->_ImportOverlays();
 
 1;