fixed pod errors.

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

diff --git a/lib/Catalyst/Request/Upload.pm b/lib/Catalyst/Request/Upload.pm
index 389f810..783733b 100644 (file)
--- a/lib/Catalyst/Request/Upload.pm
+++ b/lib/Catalyst/Request/Upload.pm
@@ -16,11 +16,12 @@ Catalyst::Request::Upload - Catalyst Request Upload Class
 
 =head1 SYNOPSIS
 
-    $upload->copy
+    $upload->copy_to
     $upload->fh
     $upload->filename;
-    $upload->link;
+    $upload->link_to;
     $upload->size;
+    $upload->slurp;
     $upload->tempname;
     $upload->type;
 
@@ -35,15 +36,21 @@ to the upload data.
 
 =over 4
 
-=item $upload->copy( $target [, $bufferlen ] )
+=item $upload->new
+
+simple constructor.
+
+=item $upload->copy_to
 
 Copies tempname using C<File::Copy>. Returns true for success, false otherwise.
 
+     $upload->copy_to('/path/to/target');
+
 =cut
 
-sub copy {
-    my ( $self, $target, $buffer ) = @_;
-    return File::Copy::copy( $self->tempname, $target, $buffer );
+sub copy_to {
+    my $self = shift;
+    return File::Copy::copy( $self->tempname, @_ );
 }
 
 =item $upload->fh
@@ -65,16 +72,16 @@ sub fh {
 
 Contains client supplied filename.
 
-=item $upload->link
+=item $upload->link_to
 
-Creates a new filename linked to the old filename.  Returns true for
-success, false otherwise.
+Creates a hard link to the tempname.  Returns true for success, 
+false otherwise.
 
-    $upload->link('/my/path');
+    $upload->link_to('/path/to/target');
 
 =cut
 
-sub link {
+sub link_to {
     my ( $self, $target ) = @_;
     return CORE::link( $self->tempname, $target );
 }
@@ -83,6 +90,31 @@ sub link {
 
 Contains size of the file in bytes.
 
+=item $upload->slurp
+
+Returns a scalar containing contents of tempname.
+
+=cut
+
+sub slurp {
+    my ( $self, $layer ) = @_;
+
+    unless ( $layer ) {
+        $layer = ':raw';
+    }
+
+    my $content = undef;
+    my $handle  = $self->fh;
+
+    binmode( $handle, $layer );
+
+    while ( $handle->sysread( my $buffer, 8192 ) ) {
+        $content .= $buffer;
+    }
+
+    return $content;
+}
+
 =item $upload->tempname
 
 Contains path to the temporary spool file.