# BEGIN BPS TAGGED BLOCK {{{
-#
+#
# COPYRIGHT:
-#
-# This software is Copyright (c) 1996-2005 Best Practical Solutions, LLC
-# <jesse@bestpractical.com>
-#
+#
+# This software is Copyright (c) 1996-2014 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::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 RT::Template;
-use vars qw( @ISA );
-@ISA= qw(RT::SearchBuilder);
+use base 'RT::SearchBuilder';
+sub Table { 'Templates'}
-sub _Init {
- my $self = shift;
- $self->{'table'} = 'Templates';
- $self->{'primary_key'} = 'id';
+=head2 LimitToNotInQueue
- return ( $self->SUPER::_Init(@_) );
+Takes a queue id # and limits the returned set of templates to those which
+aren't that queue's templates.
+
+=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 => '='
+ );
}
- eval "require RT::Templates_Overlay";
- if ($@ && $@ !~ qr{^Can't locate RT/Templates_Overlay.pm}) {
- die $@;
- };
- eval "require RT::Templates_Vendor";
- if ($@ && $@ !~ qr{^Can't locate RT/Templates_Vendor.pm}) {
- die $@;
- };
+=head2 LimitToQueue
- eval "require RT::Templates_Local";
- if ($@ && $@ !~ qr{^Can't locate RT/Templates_Local.pm}) {
- die $@;
- };
+Takes a queue id # and limits the returned set of templates to that queue's
+templates
+=cut
+sub LimitToQueue {
+ my $self = shift;
+ my $queue_id = shift;
+ $self->Limit(FIELD => 'Queue',
+ VALUE => "$queue_id",
+ OPERATOR => '='
+ );
+}
-=head1 SEE ALSO
+=head2 Next
-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.
+Returns the next template that this user can see.
-These overlay files can contain new subs or subs to replace existing subs in this module.
+=cut
+
+sub Next {
+ my $self = shift;
+
+
+ my $templ = $self->SUPER::Next();
+ if ((defined($templ)) and (ref($templ))) {
+
+ # If it's part of a queue, and the user can read templates in
+ # that queue, or the user can globally read templates, show it
+ if ($templ->Queue && $templ->CurrentUserHasQueueRight('ShowTemplate') or
+ $templ->CurrentUser->HasRight(Object => $RT::System, Right => 'ShowTemplate') or
+ $templ->CurrentUser->HasRight(Object => $RT::System, Right => 'ShowGlobalTemplates')) {
+ return($templ);
+ }
+
+ #If the user doesn't have the right to show this template
+ else {
+ return($self->Next());
+ }
+ }
+ #if there never was any template
+ else {
+ return(undef);
+ }
+
+}
-Each of these files should begin with the line
+=head2 NewItem
- no warnings qw(redefine);
+Returns an empty new RT::Template item
-so that perl does not kick and scream when you redefine a subroutine or variable in your overlay.
+=cut
-RT::Templates_Overlay, RT::Templates_Vendor, RT::Templates_Local
+sub NewItem {
+ my $self = shift;
+ return(RT::Template->new($self->CurrentUser));
+}
-=cut
+RT::Base->_ImportOverlays();
1;
projects / freeside.git / blobdiff