X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=rt%2Flib%2FRT%2FTemplates.pm;h=c5a49fe44f1b03b419b686bd1bd7b8e96ee857dd;hp=37db840868dba17e467b3be860d3f8b08f1af54f;hb=de9d037528895f7151a9aead6724ce2df95f9586;hpb=f7fd2a3e34da751cbc02bbf215e99c6dc89adc15 diff --git a/rt/lib/RT/Templates.pm b/rt/lib/RT/Templates.pm index 37db84086..c5a49fe44 100755 --- a/rt/lib/RT/Templates.pm +++ b/rt/lib/RT/Templates.pm @@ -1,115 +1,145 @@ -# BEGIN LICENSE BLOCK -# -# Copyright (c) 1996-2003 Jesse Vincent -# -# (Except where explictly superceded by other copyright notices) -# +# BEGIN BPS TAGGED BLOCK {{{ +# +# COPYRIGHT: +# +# This software is Copyright (c) 1996-2017 Best Practical Solutions, LLC +# +# +# (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. -# -# Unless otherwise specified, all modifications, corrections or -# extensions to this work which alter its source code become the -# property of Best Practical Solutions, LLC when submitted for -# inclusion in the work. -# -# -# END LICENSE BLOCK -# Autogenerated by DBIx::SearchBuilder factory (by ) -# WARNING: THIS FILE IS AUTOGENERATED. ALL CHANGES TO THIS FILE WILL BE LOST. -# -# !! DO NOT EDIT THIS FILE !! # - -use strict; - +# 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., 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 +# you are the copyright holder for those contributions and you grant +# Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable, +# 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 }}} =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; +=cut -use RT::SearchBuilder; -use RT::Template; -use vars qw( @ISA ); -@ISA= qw(RT::SearchBuilder); +package RT::Templates; +use strict; +use warnings; -sub _Init { - my $self = shift; - $self->{'table'} = 'Templates'; - $self->{'primary_key'} = 'id'; +use base 'RT::SearchBuilder'; +use RT::Template; - return ( $self->SUPER::_Init(@_) ); -} +sub Table { 'Templates'} -=item NewItem +=head2 LimitToNotInQueue -Returns an empty new RT::Template item +Takes a queue id # and limits the returned set of templates to those which +aren't that queue's templates. =cut -sub NewItem { +sub LimitToNotInQueue { my $self = shift; - return(RT::Template->new($self->CurrentUser)); + my $queue_id = shift; + $self->Limit(FIELD => 'Queue', + VALUE => "$queue_id", + 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 LimitToGlobal - eval "require RT::Templates_Local"; - if ($@ && $@ !~ qr{^Can't locate RT/Templates_Local.pm}) { - die $@; - }; +Takes no arguments. Limits the returned set to "Global" templates +which can be used with any queue. +=cut +sub LimitToGlobal { + my $self = shift; + $self->Limit(FIELD => 'Queue', + VALUE => "0", + OPERATOR => '=' + ); +} -=head1 SEE ALSO +=head2 LimitToQueue -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. +Takes a queue id # and limits the returned set of templates to that queue's +templates -These overlay files can contain new subs or subs to replace existing subs in this module. +=cut -If you'll be working with perl 5.6.0 or greater, each of these files should begin with the line +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;