Changeset 2504

Timestamp:

05/30/08 17:54:19 (7 months ago)

Author:

david

Message:

Added convenience methods to AgaviUploadedFile?, closes #607

Location:

branches/0.11

Files:

• CHANGELOG (modified) (1 diff)
• src/request/AgaviUploadedFile.class.php (modified) (2 diffs)

branches/0.11/CHANGELOG

@@ -5 +5 @@
 --------------------------
 
+ADD: Add convenience methods to AgaviUploadedFile (#607) (David)
 ADD: Change error class handling in FPF to set classes on elements returned by the respective XPath expressions, not the original elements (#768) (David)
 ADD: Allow arrays as values for web request sources. (#675) (David)

branches/0.11/src/request/AgaviUploadedFile.class.php

@@ -128 +128 @@
   
   /**
+   * Retrieve the contents of the uploaded file.
+   *
+   * @return     string The file contents.
+   *
+   * @throws     AgaviException If the file has errors or has been moved.
+   *
+   * @author     David Zülke <dz@bitxtender.com>
+   * @since      0.11.2
+   */
+  public function getContents()
+  {
+    if($this->hasError() || !$this->isMovable()) {
+      throw new AgaviException('Cannot get contents of erroneous or moved file.');
+    }
+    
+    return file_get_contents($this->tmp_name);
+  }
+  
+  /**
+   * Retrieve a stream handle of the uploaded file.
+   *
+   * @param      string The fopen mode, defaults to 'rb'.
+   *
+   * @return     resource The stream.
+   *
+   * @throws     AgaviException If the file has errors or has been moved.
+   *
+   * @author     David Zülke <dz@bitxtender.com>
+   * @since      0.11.2
+   */
+  public function getStream($mode = 'rb')
+  {
+    if($this->hasError() || !$this->isMovable()) {
+      throw new AgaviException('Cannot get contents of erroneous or moved file.');
+    }
+    
+    return fopen($this->tmp_name, $mode);
+  }
+  
+  /**
    * Move the uploaded file.
    *
@@ -135 +175 @@
    * @param      int    The mode to use when creating subdirs, defaults to 0775.
    *
-   * @return     bool   True, if the operation was successful, false otherwise.
+   * @return     bool True, if the operation was successful, false otherwise.
    *
    * @throws     AgaviFileException If chmod or mkdir calls failed.