Changeset 37 for trunk/lib/Upload.inc.php

Timestamp:

Dec 14, 2005 7:07:43 AM (18 years ago)

Author:

scdev

Message:

updated messaging functionality in Upload::

File:

• trunk/lib/Upload.inc.php (modified) (13 diffs)

trunk/lib/Upload.inc.php

@@ -8 +8 @@
  * @author  Quinn Comendant <quinn@strangecode.com>
  * @requires App.inc.php
- * @version 1.2
+ * @version 1.3
  */
+
+// Message Types.
+define('UPLOAD_MSG_ERR', MSG_ERR);
+define('UPLOAD_MSG_ERROR', MSG_ERROR);
+define('UPLOAD_MSG_WARNING', MSG_WARNING);
+define('UPLOAD_MSG_NOTICE', MSG_NOTICE);
+define('UPLOAD_MSG_SUCCESS', MSG_SUCCESS);
+define('UPLOAD_MSG_ALL', MSG_SUCCESS + MSG_NOTICE + MSG_WARNING + MSG_ERROR);
 
 require_once dirname(__FILE__) . '/App.inc.php';
@@ -18 +26 @@
     var $_params = array(
     
-        // Display message with raiseMsg?
-        'display_messages' => true,
+        // Which messages do we pass to raiseMsg?
+        'display_messages' => UPLOAD_MSG_ALL,
         
         // Existing files will be overwritten when there is a name conflict?
@@ -267 +275 @@
 
     /**
-     *
+     * Process uploaded files. Processes files existing within the specified $_FILES['form_name'] array.
+     * It tests for errors, cleans the filename, optionally sets custom file names. It will process 
+     * multiple files automatically if the file form element is an array (<input type="file" name="myfiles[]" />).
+     *
+     * @access  public
+     * @param   string  $form_name          The name of the form to process.
+     * @param   string  $custom_file_name   The new name of the file. does not work if processing multiple files.
+     * @return  mixed   Returns FALSE if a major error occured preventing any file uploads.
+     *                  Returns an empty array if any minor errors occured or no files were found.
+     *                  Returns a multidimentional array of filenames, sizes and extentions, if one-or-more files succeeded uploading.
+     *                  Note: this last option presents a problem in the case of when some files uploaded successfully, and some failed.
+     *                        In this case it is necessary to check the Upload::anyErrors method to discover if any did fail.
      */
     function process($form_name, $custom_file_name=null)
@@ -448 +467 @@
     
     /**
-     *
+     * Remove file within upload path.
+     *
+     * @access  public
+     * @param   string  $file_name  A name of a file.
+     * @return  bool                Success of operation.
      */
     function deleteFile($file_name)
@@ -466 +489 @@
             App::logMsg(sprintf('Deleted file: %s', $file_path_name), LOG_DEBUG, __FILE__, __LINE__);
         } else {
-            $this->raiseMsg(sprintf(_("The file <strong>%s</strong> could not be deleted."), $file_name), MSG_ERROR, __FILE__, __LINE__);
+            $this->raiseMsg(sprintf(_("The file <strong>%s</strong> could not be deleted."), $file_name), MSG_ERR, __FILE__, __LINE__);
             App::logMsg(sprintf(_("Failed deleting file: %s"), $file_path_name), LOG_ERR, __FILE__, __LINE__);
             return false;
@@ -473 +496 @@
     
     /**
-     *
+     * Renames a file within the upload path.
+     *
+     * @access  public
+     * @param   string  $old_name   The currently existing file name.
+     * @param   string  $new_name   The new name for this file.
+     * @return  bool                Success of operation.
      */
     function moveFile($old_name, $new_name)
@@ -490 +518 @@
                 App::logMsg(sprintf('File renamed from %s to %s', $old_file_path_name, $new_file_path_name), LOG_DEBUG, __FILE__, __LINE__);
             } else {
-                $this->raiseMsg(sprintf(_("Error renaming file to %s"), $new_file_path_name), MSG_ERR, __FILE__, __LINE__);
-                App::logMsg(sprintf(_("Error renaming file to %s"), $new_file_path_name), LOG_ERR, __FILE__, __LINE__);
+                $this->raiseMsg(sprintf(_("Error renaming file to %s"), $new_file_path_name), MSG_WARNING, __FILE__, __LINE__);
+                App::logMsg(sprintf(_("Error renaming file to %s"), $new_file_path_name), LOG_WARNING, __FILE__, __LINE__);
                 return false;
             }
         } else {
-            $this->raiseMsg(sprintf(_("Couldn't rename nonexistent file <strong>%s</strong>."), $old_name), MSG_ERR, __FILE__, __LINE__);
-            App::logMsg(sprintf(_("Error renaming nonexistent file: %s"), $old_file_path_name), LOG_ERR, __FILE__, __LINE__);
+            $this->raiseMsg(sprintf(_("Couldn't rename nonexistent file <strong>%s</strong>."), $old_name), MSG_WARNING, __FILE__, __LINE__);
+            App::logMsg(sprintf(_("Error renaming nonexistent file: %s"), $old_file_path_name), LOG_WARNING, __FILE__, __LINE__);
             return false;
         }
@@ -502 +530 @@
     
     /**
-     *
+     * Tests if a file exists within the current upload_path.
+     *
+     * @access  public
+     * @param   string  $file_name  A name of a file.
+     * @return  bool                Existence of file.
      */
     function exists($file_name)
@@ -536 +568 @@
 
     /**
-     *
+     * Returns an array of file names that failed uploading.
+     *
+     * @access  public
+     * @return  array   List of file names.
      */
     function getErrors()
@@ -544 +579 @@
 
     /**
-     *
+     * Determintes if any errors occured while calling the Upload::process method.
+     *
+     * @access  public
      */
     function anyErrors()
@@ -552 +589 @@
 
     /**
-     *
+     * Removes unsafe characters from file name.
+     *
+     * @access  public
+     * @param   string  $file_name  A name of a file.
+     * @return  string              The same name, but cleaned.
      */
     function cleanFileName($file_name)
@@ -565 +606 @@
     }
 
-    /**
-     *
+
+    /**
+     * Returns the extention of a file name, or an empty string if non exists.
+     *
+     * @access  public
+     * @param   string  $file_name  A name of a file, with extention after a dot.
+     * @return  string              The value found after the dot
      */
     function getFilenameExtension($file_name)
     {
-        preg_match('/.*?\.(\w+)$/i', $file_name, $ext);
+        preg_match('/.*?\.(\w+)$/i', trim($file_name), $ext);
         return isset($ext[1]) ? $ext[1] : '';
     }
     
     /**
-     * An alias for App::raiseMsg that only sends messages if display_messages is true.
+     * An alias for App::raiseMsg that only sends messages configured by display_messages.
      *
      * @access public
@@ -587 +633 @@
     function raiseMsg($message, $type, $file, $line)
     {
-        if ($this->getParam('display_messages')) {
+        if ($this->getParam('display_messages') === true || (is_int($this->getParam('display_messages')) && $this->getParam('display_messages') >= $type)) {
             App::raiseMsg($message, $type, $file, $line);
         }