rt 4.2.14 (#13852)

[freeside.git] / rt / lib / RT / Templates.pm

diff --git a/rt/lib/RT/Templates.pm b/rt/lib/RT/Templates.pm
index 97b37c5..c5a49fe 100755 (executable)
--- a/rt/lib/RT/Templates.pm
+++ b/rt/lib/RT/Templates.pm
@@ -2,7 +2,7 @@
 #
 # COPYRIGHT:
 #
-# This software is Copyright (c) 1996-2011 Best Practical Solutions, LLC
+# This software is Copyright (c) 1996-2017 Best Practical Solutions, LLC
 #                                          <sales@bestpractical.com>
 #
 # (Except where explicitly superseded by other copyright notices)
@@ -46,78 +46,100 @@
 #
 # 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;
-
-
 =head1 NAME
 
-  RT::Templates -- Class Description
- 
+  RT::Templates - a collection of RT Template objects
+
 =head1 SYNOPSIS
 
-  use RT::Templates
+  use RT::Templates;
 
 =head1 DESCRIPTION
 
 
 =head1 METHODS
 
+
 =cut
 
+
 package RT::Templates;
 
-use RT::SearchBuilder;
+use strict;
+use warnings;
+
+use base 'RT::SearchBuilder';
+
 use RT::Template;
 
-use vars qw( @ISA );
-@ISA= qw(RT::SearchBuilder);
+sub Table { 'Templates'}
 
 
-sub _Init {
-    my $self = shift;
-    $self->{'table'} = 'Templates';
-    $self->{'primary_key'} = 'id';
+=head2 LimitToNotInQueue
 
+Takes a queue id # and limits the returned set of templates to those which 
+aren't that queue's templates.
 
-    return ( $self->SUPER::_Init(@_) );
+=cut
+
+sub LimitToNotInQueue {
+    my $self = shift;
+    my $queue_id = shift;
+    $self->Limit(FIELD => 'Queue',
+                 VALUE => "$queue_id",
+                 OPERATOR => '!='
+                );
 }
 
 
-=head2 NewItem
+=head2 LimitToGlobal
 
-Returns an empty new RT::Template item
+Takes no arguments. Limits the returned set to "Global" templates
+which can be used with any queue.
 
 =cut
 
-sub NewItem {
+sub LimitToGlobal {
     my $self = shift;
-    return(RT::Template->new($self->CurrentUser));
+    $self->Limit(FIELD => 'Queue',
+                 VALUE => "0",
+                 OPERATOR => '='
+                );
 }
-RT::Base->_ImportOverlays();
 
-=head1 SEE ALSO
 
-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.  
+=head2 LimitToQueue
 
-These overlay files can contain new subs or subs to replace existing subs in this module.
+Takes a queue id # and limits the returned set of templates to that queue's
+templates
 
-Each of these files should begin with the line 
+=cut
+
+sub LimitToQueue {
+    my $self = shift;
+    my $queue_id = shift;
+    $self->Limit(FIELD => 'Queue',
+                 VALUE => "$queue_id",
+                 OPERATOR => '='
+                );
+}
 
-   no warnings qw(redefine);
 
-so that perl does not kick and scream when you redefine a subroutine or variable in your overlay.
+=head2 AddRecord
 
-RT::Templates_Overlay, RT::Templates_Vendor, RT::Templates_Local
+Overrides the collection to ensure that only templates the user can see
+are returned.
 
 =cut
 
+sub AddRecord {
+    my $self = shift;
+    my ($record) = @_;
+
+    return unless $record->CurrentUserCanRead;
+    return $self->SUPER::AddRecord( $record );
+}
+
+RT::Base->_ImportOverlays();
 
 1;