Reformatted documentation

[catagits/Catalyst-Runtime.git] / lib / Catalyst / Request / Upload.pm

diff --git a/lib/Catalyst/Request/Upload.pm b/lib/Catalyst/Request/Upload.pm
index 2cd3eb9..9a5f1c4 100644 (file)
--- a/lib/Catalyst/Request/Upload.pm
+++ b/lib/Catalyst/Request/Upload.pm
@@ -3,22 +3,27 @@ package Catalyst::Request::Upload;
 use strict;
 use base 'Class::Accessor::Fast';
 
-use IO::File;
+use Catalyst::Exception;
+use File::Copy ();
+use IO::File   ();
 
-__PACKAGE__->mk_accessors(qw/filename size tempname type/);
+__PACKAGE__->mk_accessors(qw/filename headers size tempname type/);
 
 sub new { shift->SUPER::new( ref( $_[0] ) ? $_[0] : {@_} ) }
 
 =head1 NAME
 
-Catalyst::Request::Upload - Catalyst Request Upload Class
+Catalyst::Request::Upload - handles file upload requests
 
 =head1 SYNOPSIS
 
-    $upload->fh
+    $upload->copy_to;
+    $upload->fh;
     $upload->filename;
-    $upload->link;
+    $upload->headers;
+    $upload->link_to;
     $upload->size;
+    $upload->slurp;
     $upload->tempname;
     $upload->type;
 
@@ -26,65 +31,113 @@ See also L<Catalyst>.
 
 =head1 DESCRIPTION
 
-This is the Catalyst Request Upload class, which provides a set of accessors to the
-upload data.
+This class provides accessors and methods to handle client upload requests.
 
 =head1 METHODS
 
-=over 4
+=head2 $upload->new
 
-=item $upload->fh
+Simple constructor.
 
-Opens tempname and returns a C<IO::File> handle.
+=head2 $upload->copy_to
+
+Copies the temporary file using L<File::Copy>. Returns true for success,
+false for failure.
+
+     $upload->copy_to('/path/to/target');
+
+=cut
+
+sub copy_to {
+    my $self = shift;
+    return File::Copy::copy( $self->tempname, @_ );
+}
+
+=head2 $upload->fh
+
+Opens a temporary file (see tempname below) and returns an L<IO::File> handle.
 
 =cut
 
 sub fh {
     my $self = shift;
 
-    my $fh = IO::File->new( $self->tempname, O_RDONLY )
-      or die( "Can't open ", $self->tempname, ": ", $! );
+    my $fh = IO::File->new( $self->tempname, IO::File::O_RDONLY );
+
+    unless ( defined $fh ) {
+
+        my $filename = $self->tempname;
+
+        Catalyst::Exception->throw(
+            message => qq/Can't open '$filename': '$!'/ );
+    }
 
     return $fh;
 }
 
-=item $upload->filename
+=head2 $upload->filename
 
-Contains client supplied filename.
+Returns the client-supplied filename.
 
-=item $upload->link
+=head2 $upload->headers
 
-Creates a new filename linked to the old filename.  Returns true for
-success, false otherwise.
+Returns an L<HTTP::Headers> object for the request.
 
-    $upload->link('/my/path');
+=head2 $upload->link_to
 
-=cut
+Creates a hard link to the temporary file. Returns true for success, 
+false for failure.
 
-sub link {
-    my $self   = shift;
-    my $target = shift;
+    $upload->link_to('/path/to/target');
 
-    return link( $self->tempname, $target );
+=cut
+
+sub link_to {
+    my ( $self, $target ) = @_;
+    return CORE::link( $self->tempname, $target );
 }
 
-=item $upload->size
+=head2 $upload->size
 
-Contains size of the file in bytes.
+Returns the size of the uploaded file in bytes.
 
-=item $upload->tempname
+=head2 $upload->slurp
 
-Contains path to the temporary spool file.
+Returns a scalar containing the contents of the temporary file.
+
+=cut
 
-=item $upload->type
+sub slurp {
+    my ( $self, $layer ) = @_;
 
-Contains client supplied Content-Type.
+    unless ($layer) {
+        $layer = ':raw';
+    }
 
-=back
+    my $content = undef;
+    my $handle  = $self->fh;
 
-=head1 AUTHOR
+    binmode( $handle, $layer );
+
+    while ( $handle->sysread( my $buffer, 8192 ) ) {
+        $content .= $buffer;
+    }
+
+    return $content;
+}
+
+=head2 $upload->tempname
+
+Returns the path to the temporary file.
+
+=head2 $upload->type
+
+Returns the client-supplied Content-Type.
+
+=head1 AUTHORS
 
 Sebastian Riedel, C<sri@cpan.org>
+
 Christian Hansen, C<ch@ngmedia.com>
 
 =head1 COPYRIGHT