import of rt 3.0.4

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

diff --git a/rt/lib/RT/Attachments.pm b/rt/lib/RT/Attachments.pm
index 73cd350..177cdd0 100755 (executable)
--- a/rt/lib/RT/Attachments.pm
+++ b/rt/lib/RT/Attachments.pm
@@ -1,99 +1,115 @@
-#$Header: /home/cvs/cvsroot/freeside/rt/lib/RT/Attachments.pm,v 1.1 2002-08-12 06:17:07 ivan Exp $
+# 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;
 
-=head1 NAME
 
-  RT::Attachments - a collection of RT::Attachment objects
+=head1 NAME
 
+  RT::Attachments -- Class Description
+ 
 =head1 SYNOPSIS
 
-  use RT::Attachments;
+  use RT::Attachments
 
 =head1 DESCRIPTION
 
-This module should never be called directly by client code. it's an internal module which
-should only be accessed through exported APIs in Ticket, Queue and other similar objects.
-
 
 =head1 METHODS
 
+=cut
 
-=begin testing
-
-ok (require RT::TestHarness);
-ok (require RT::Attachments);
+package RT::Attachments;
 
-=end testing
+use RT::SearchBuilder;
+use RT::Attachment;
 
-=cut
+use vars qw( @ISA );
+@ISA= qw(RT::SearchBuilder);
 
-package RT::Attachments;
 
-use RT::EasySearch;
+sub _Init {
+    my $self = shift;
+    $self->{'table'} = 'Attachments';
+    $self->{'primary_key'} = 'id';
 
-@ISA= qw(RT::EasySearch);
 
-# {{{ sub _Init  
-sub _Init   {
-  my $self = shift;
- 
-  $self->{'table'} = "Attachments";
-  $self->{'primary_key'} = "id";
-  return ( $self->SUPER::_Init(@_));
+    return ( $self->SUPER::_Init(@_) );
 }
-# }}}
 
 
-# {{{ sub ContentType
+=item NewItem
 
-=head2 ContentType (VALUE => 'text/plain', ENTRYAGGREGATOR => 'OR', OPERATOR => '=' ) 
-
-Limit result set to attachments of ContentType 'TYPE'...
+Returns an empty new RT::Attachment item
 
 =cut
 
+sub NewItem {
+    my $self = shift;
+    return(RT::Attachment->new($self->CurrentUser));
+}
 
-sub ContentType  {
-  my $self = shift;
-  my %args = ( VALUE => 'text/plain',
-              OPERATOR => '=',
-              ENTRYAGGREGATOR => 'OR',
-              @_);
+        eval "require RT::Attachments_Overlay";
+        if ($@ && $@ !~ qr{^Can't locate RT/Attachments_Overlay.pm}) {
+            die $@;
+        };
 
-  $self->Limit ( FIELD => 'ContentType',
-                VALUE => $args{'VALUE'},
-                OPERATOR => $args{'OPERATOR'},
-                ENTRYAGGREGATOR => $args{'ENTRYAGGREGATOR'});
-}
-# }}}
+        eval "require RT::Attachments_Vendor";
+        if ($@ && $@ !~ qr{^Can't locate RT/Attachments_Vendor.pm}) {
+            die $@;
+        };
 
-# {{{ sub ChildrenOf 
+        eval "require RT::Attachments_Local";
+        if ($@ && $@ !~ qr{^Can't locate RT/Attachments_Local.pm}) {
+            die $@;
+        };
 
-=head2 ChildrenOf ID
 
-Limit result set to children of Attachment ID
 
-=cut
 
+=head1 SEE ALSO
 
-sub ChildrenOf  {
-  my $self = shift;
-  my $attachment = shift;
-  $self->Limit ( FIELD => 'Parent',
-                VALUE => $attachment);
-}
-# }}}
+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.  
 
-# {{{ sub NewItem 
-sub NewItem  {
-  my $self = shift;
+These overlay files can contain new subs or subs to replace existing subs in this module.
 
-  use RT::Attachment;
-  my $item = new RT::Attachment($self->CurrentUser);
-  return($item);
-}
-# }}}
-  1;
+If you'll be working with perl 5.6.0 or greater, each of these files should begin with the line 
+
+   no warnings qw(redefine);
 
+so that perl does not kick and scream when you redefine a subroutine or variable in your overlay.
 
+RT::Attachments_Overlay, RT::Attachments_Vendor, RT::Attachments_Local
+
+=cut
 
 
+1;