diff options
Diffstat (limited to 'rt/lib/RT/Templates.pm')
| -rwxr-xr-x | rt/lib/RT/Templates.pm | 143 |
1 files changed, 75 insertions, 68 deletions
diff --git a/rt/lib/RT/Templates.pm b/rt/lib/RT/Templates.pm index 37db84086..b5b483c96 100755 --- a/rt/lib/RT/Templates.pm +++ b/rt/lib/RT/Templates.pm @@ -1,115 +1,122 @@ -# BEGIN LICENSE BLOCK -# -# Copyright (c) 1996-2003 Jesse Vincent <jesse@bestpractical.com> -# -# (Except where explictly superceded by other copyright notices) -# -# 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 <jesse@bestpractical.com>) -# WARNING: THIS FILE IS AUTOGENERATED. ALL CHANGES TO THIS FILE WILL BE LOST. -# -# !! DO NOT EDIT THIS FILE !! -# - -use strict; - +# $Header: /home/cvs/cvsroot/freeside/rt/lib/RT/Templates.pm,v 1.1 2002-08-12 06:17:07 ivan Exp $ =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 +=begin testing + +ok (require RT::TestHarness); +ok (require RT::Templates); + +=end testing + =cut package RT::Templates; +use RT::EasySearch; +@ISA= qw(RT::EasySearch); -use RT::SearchBuilder; -use RT::Template; -use vars qw( @ISA ); -@ISA= qw(RT::SearchBuilder); +# {{{ sub _Init +=head2 _Init -sub _Init { - my $self = shift; - $self->{'table'} = 'Templates'; - $self->{'primary_key'} = 'id'; + Returns RT::Templates specific init info like table and primary key names +=cut - return ( $self->SUPER::_Init(@_) ); +sub _Init { + + my $self = shift; + $self->{'table'} = "Templates"; + $self->{'primary_key'} = "id"; + return ($self->SUPER::_Init(@_)); } +# }}} +# {{{ LimitToNotInQueue -=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 $@; - }; +# {{{ LimitToGlobal - 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; + my $queue_id = shift; + $self->Limit(FIELD => 'Queue', + VALUE => "0", + OPERATOR => '=' + ); +} +# }}} +# {{{ LimitToQueue -=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); +# {{{ sub NewItem -so that perl does not kick and scream when you redefine a subroutine or variable in your overlay. +=head2 NewItem -RT::Templates_Overlay, RT::Templates_Vendor, RT::Templates_Local +Returns a new empty Template object =cut +sub NewItem { + my $self = shift; + + use RT::Template; + my $item = new RT::Template($self->CurrentUser); + return($item); +} +# }}} 1; + |