rt/lib/RT/Template.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2007 Best Practical Solutions, LLC
   6 #                                          <jesse@bestpractical.com>
   7 #
   8 # (Except where explicitly superseded by other copyright notices)
   9 #
  10 #
  11 # LICENSE:
  12 #
  13 # This work is made available to you under the terms of Version 2 of
  14 # the GNU General Public License. A copy of that license should have
  15 # been provided with this software, but in any event can be snarfed
  16 # from www.gnu.org.
  17 #
  18 # This work is distributed in the hope that it will be useful, but
  19 # WITHOUT ANY WARRANTY; without even the implied warranty of
  20 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  21 # General Public License for more details.
  22 #
  23 # You should have received a copy of the GNU General Public License
  24 # along with this program; if not, write to the Free Software
  25 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  26 # 02110-1301 or visit their web page on the internet at
  27 # http://www.gnu.org/copyleft/gpl.html.
  28 #
  29 #
  30 # CONTRIBUTION SUBMISSION POLICY:
  31 #
  32 # (The following paragraph is not intended to limit the rights granted
  33 # to you to modify and distribute this software under the terms of
  34 # the GNU General Public License and is only of importance to you if
  35 # you choose to contribute your changes and enhancements to the
  36 # community by submitting them to Best Practical Solutions, LLC.)
  37 #
  38 # By intentionally submitting any modifications, corrections or
  39 # derivatives to this work, or any other work intended for use with
  40 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
  41 # you are the copyright holder for those contributions and you grant
  42 # Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
  43 # royalty-free, perpetual, license to use, copy, create derivative
  44 # works based on those contributions, and sublicense and distribute
  45 # those contributions and any derivatives thereof.
  46 #
  47 # END BPS TAGGED BLOCK }}}
  48 # Autogenerated by DBIx::SearchBuilder factory (by <jesse@bestpractical.com>)
  49 # WARNING: THIS FILE IS AUTOGENERATED. ALL CHANGES TO THIS FILE WILL BE LOST.
  50 #
  51 # !! DO NOT EDIT THIS FILE !!
  52 #
  53
  54 use strict;
  55
  56
  57 =head1 NAME
  58
  59 RT::Template
  60
  61
  62 =head1 SYNOPSIS
  63
  64 =head1 DESCRIPTION
  65
  66 =head1 METHODS
  67
  68 =cut
  69
  70 package RT::Template;
  71 use RT::Record;
  72 use RT::Queue;
  73
  74
  75 use vars qw( @ISA );
  76 @ISA= qw( RT::Record );
  77
  78 sub _Init {
  79   my $self = shift;
  80
  81   $self->Table('Templates');
  82   $self->SUPER::_Init(@_);
  83 }
  84
  85
  86
  87
  88
  89 =head2 Create PARAMHASH
  90
  91 Create takes a hash of values and creates a row in the database:
  92
  93   int(11) 'Queue'.
  94   varchar(200) 'Name'.
  95   varchar(255) 'Description'.
  96   varchar(16) 'Type'.
  97   varchar(16) 'Language'.
  98   int(11) 'TranslationOf'.
  99   blob 'Content'.
 100
 101 =cut
 102
 103
 104
 105
 106 sub Create {
 107     my $self = shift;
 108     my %args = (
 109                 Queue => '0',
 110                 Name => '',
 111                 Description => '',
 112                 Type => '',
 113                 Language => '',
 114                 TranslationOf => '0',
 115                 Content => '',
 116
 117                   @_);
 118     $self->SUPER::Create(
 119                          Queue => $args{'Queue'},
 120                          Name => $args{'Name'},
 121                          Description => $args{'Description'},
 122                          Type => $args{'Type'},
 123                          Language => $args{'Language'},
 124                          TranslationOf => $args{'TranslationOf'},
 125                          Content => $args{'Content'},
 126 );
 127
 128 }
 129
 130
 131
 132 =head2 id
 133
 134 Returns the current value of id.
 135 (In the database, id is stored as int(11).)
 136
 137
 138 =cut
 139
 140
 141 =head2 Queue
 142
 143 Returns the current value of Queue.
 144 (In the database, Queue is stored as int(11).)
 145
 146
 147
 148 =head2 SetQueue VALUE
 149
 150
 151 Set Queue to VALUE.
 152 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 153 (In the database, Queue will be stored as a int(11).)
 154
 155
 156 =cut
 157
 158
 159 =head2 QueueObj
 160
 161 Returns the Queue Object which has the id returned by Queue
 162
 163
 164 =cut
 165
 166 sub QueueObj {
 167         my $self = shift;
 168         my $Queue =  RT::Queue->new($self->CurrentUser);
 169         $Queue->Load($self->__Value('Queue'));
 170         return($Queue);
 171 }
 172
 173 =head2 Name
 174
 175 Returns the current value of Name.
 176 (In the database, Name is stored as varchar(200).)
 177
 178
 179
 180 =head2 SetName VALUE
 181
 182
 183 Set Name to VALUE.
 184 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 185 (In the database, Name will be stored as a varchar(200).)
 186
 187
 188 =cut
 189
 190
 191 =head2 Description
 192
 193 Returns the current value of Description.
 194 (In the database, Description is stored as varchar(255).)
 195
 196
 197
 198 =head2 SetDescription VALUE
 199
 200
 201 Set Description to VALUE.
 202 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 203 (In the database, Description will be stored as a varchar(255).)
 204
 205
 206 =cut
 207
 208
 209 =head2 Type
 210
 211 Returns the current value of Type.
 212 (In the database, Type is stored as varchar(16).)
 213
 214
 215
 216 =head2 SetType VALUE
 217
 218
 219 Set Type to VALUE.
 220 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 221 (In the database, Type will be stored as a varchar(16).)
 222
 223
 224 =cut
 225
 226
 227 =head2 Language
 228
 229 Returns the current value of Language.
 230 (In the database, Language is stored as varchar(16).)
 231
 232
 233
 234 =head2 SetLanguage VALUE
 235
 236
 237 Set Language to VALUE.
 238 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 239 (In the database, Language will be stored as a varchar(16).)
 240
 241
 242 =cut
 243
 244
 245 =head2 TranslationOf
 246
 247 Returns the current value of TranslationOf.
 248 (In the database, TranslationOf is stored as int(11).)
 249
 250
 251
 252 =head2 SetTranslationOf VALUE
 253
 254
 255 Set TranslationOf to VALUE.
 256 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 257 (In the database, TranslationOf will be stored as a int(11).)
 258
 259
 260 =cut
 261
 262
 263 =head2 Content
 264
 265 Returns the current value of Content.
 266 (In the database, Content is stored as blob.)
 267
 268
 269
 270 =head2 SetContent VALUE
 271
 272
 273 Set Content to VALUE.
 274 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 275 (In the database, Content will be stored as a blob.)
 276
 277
 278 =cut
 279
 280
 281 =head2 LastUpdated
 282
 283 Returns the current value of LastUpdated.
 284 (In the database, LastUpdated is stored as datetime.)
 285
 286
 287 =cut
 288
 289
 290 =head2 LastUpdatedBy
 291
 292 Returns the current value of LastUpdatedBy.
 293 (In the database, LastUpdatedBy is stored as int(11).)
 294
 295
 296 =cut
 297
 298
 299 =head2 Creator
 300
 301 Returns the current value of Creator.
 302 (In the database, Creator is stored as int(11).)
 303
 304
 305 =cut
 306
 307
 308 =head2 Created
 309
 310 Returns the current value of Created.
 311 (In the database, Created is stored as datetime.)
 312
 313
 314 =cut
 315
 316
 317
 318 sub _CoreAccessible {
 319     {
 320
 321         id =>
 322                 {read => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => ''},
 323         Queue =>
 324                 {read => 1, write => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
 325         Name =>
 326                 {read => 1, write => 1, sql_type => 12, length => 200,  is_blob => 0,  is_numeric => 0,  type => 'varchar(200)', default => ''},
 327         Description =>
 328                 {read => 1, write => 1, sql_type => 12, length => 255,  is_blob => 0,  is_numeric => 0,  type => 'varchar(255)', default => ''},
 329         Type =>
 330                 {read => 1, write => 1, sql_type => 12, length => 16,  is_blob => 0,  is_numeric => 0,  type => 'varchar(16)', default => ''},
 331         Language =>
 332                 {read => 1, write => 1, sql_type => 12, length => 16,  is_blob => 0,  is_numeric => 0,  type => 'varchar(16)', default => ''},
 333         TranslationOf =>
 334                 {read => 1, write => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
 335         Content =>
 336                 {read => 1, write => 1, sql_type => -4, length => 0,  is_blob => 1,  is_numeric => 0,  type => 'blob', default => ''},
 337         LastUpdated =>
 338                 {read => 1, auto => 1, sql_type => 11, length => 0,  is_blob => 0,  is_numeric => 0,  type => 'datetime', default => ''},
 339         LastUpdatedBy =>
 340                 {read => 1, auto => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
 341         Creator =>
 342                 {read => 1, auto => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
 343         Created =>
 344                 {read => 1, auto => 1, sql_type => 11, length => 0,  is_blob => 0,  is_numeric => 0,  type => 'datetime', default => ''},
 345
 346  }
 347 };
 348
 349
 350         eval "require RT::Template_Overlay";
 351         if ($@ && $@ !~ qr{^Can't locate RT/Template_Overlay.pm}) {
 352             die $@;
 353         };
 354
 355         eval "require RT::Template_Vendor";
 356         if ($@ && $@ !~ qr{^Can't locate RT/Template_Vendor.pm}) {
 357             die $@;
 358         };
 359
 360         eval "require RT::Template_Local";
 361         if ($@ && $@ !~ qr{^Can't locate RT/Template_Local.pm}) {
 362             die $@;
 363         };
 364
 365
 366
 367
 368 =head1 SEE ALSO
 369
 370 This class allows "overlay" methods to be placed
 371 into the following files _Overlay is for a System overlay by the original author,
 372 _Vendor is for 3rd-party vendor add-ons, while _Local is for site-local customizations.
 373
 374 These overlay files can contain new subs or subs to replace existing subs in this module.
 375
 376 Each of these files should begin with the line
 377
 378    no warnings qw(redefine);
 379
 380 so that perl does not kick and scream when you redefine a subroutine or variable in your overlay.
 381
 382 RT::Template_Overlay, RT::Template_Vendor, RT::Template_Local
 383
 384 =cut
 385
 386
 387 1;