Wordpress 2.7.1

[autoinstalls/wordpress.git] / wp-admin / includes / class-pclzip.php

diff --git a/wp-admin/includes/class-pclzip.php b/wp-admin/includes/class-pclzip.php
index b49074444852dd0d88725699c4b3067305ddd210..fcc5351c52503db198d5aee09a82516894c89e72 100644 (file)
--- a/wp-admin/includes/class-pclzip.php
+++ b/wp-admin/includes/class-pclzip.php
@@ -1,51 +1,60 @@
 <?php
-// --------------------------------------------------------------------------------
-// PhpConcept Library - Zip Module 2.5
-// --------------------------------------------------------------------------------
-// License GNU/LGPL - Vincent Blavet - March 2006
-// http://www.phpconcept.net
-// --------------------------------------------------------------------------------
-//
-// Presentation :
-//   PclZip is a PHP library that manage ZIP archives.
-//   So far tests show that archives generated by PclZip are readable by
-//   WinZip application and other tools.
-//
-// Description :
-//   See readme.txt and http://www.phpconcept.net
-//
-// Warning :
-//   This library and the associated files are non commercial, non professional
-//   work.
-//   It should not have unexpected results. However if any damage is caused by
-//   this software the author can not be responsible.
-//   The use of this software is at the risk of the user.
-//
-// --------------------------------------------------------------------------------
-// $Id: pclzip.lib.php,v 1.44 2006/03/08 21:23:59 vblavet Exp $
-// --------------------------------------------------------------------------------
-
-  // ----- Constants
-  define( 'PCLZIP_READ_BLOCK_SIZE', 2048 );
-
-  // ----- File list separator
-  // In version 1.x of PclZip, the separator for file list is a space
-  // (which is not a very smart choice, specifically for windows paths !).
-  // A better separator should be a comma (,). This constant gives you the
-  // abilty to change that.
-  // However notice that changing this value, may have impact on existing
-  // scripts, using space separated filenames.
-  // Recommanded values for compatibility with older versions :
-  //define( 'PCLZIP_SEPARATOR', ' ' );
-  // Recommanded values for smart separation of filenames.
-  define( 'PCLZIP_SEPARATOR', ',' );
-
-  // ----- Error configuration
-  // 0 : PclZip Class integrated error handling
-  // 1 : PclError external library error handling. By enabling this
-  //     you must ensure that you have included PclError library.
-  // [2,...] : reserved for futur use
-  define( 'PCLZIP_ERROR_EXTERNAL', 0 );
+/**
+ * PhpConcept Library - Zip Module 2.5
+ *
+ * Presentation :
+ *   PclZip is a PHP library that manage ZIP archives.
+ *   So far tests show that archives generated by PclZip are readable by
+ *   WinZip application and other tools.
+ *
+ * Warning :
+ *   This library and the associated files are non commercial, non professional
+ *   work.
+ *   It should not have unexpected results. However if any damage is caused by
+ *   this software the author can not be responsible.
+ *   The use of this software is at the risk of the user.
+ *
+ * @package External
+ * @subpackage PclZip
+ *
+ * @license License GNU/LGPL
+ * @copyright March 2006 Vincent Blavet
+ * @author Vincent Blavet
+ * @link http://www.phpconcept.net
+ * @version $Id: pclzip.lib.php,v 1.44 2006/03/08 21:23:59 vblavet Exp $
+ */
+
+/**
+ * The read block size for reading zip files.
+ *
+ * @since 2.5
+ */
+define( 'PCLZIP_READ_BLOCK_SIZE', 2048 );
+
+/**
+ * File list separator
+ *
+ * In version 1.x of PclZip, the separator for file list is a space(which is not
+ * a very smart choice, specifically for windows paths !). A better separator
+ * should be a comma (,). This constant gives you the abilty to change that.
+ *
+ * However notice that changing this value, may have impact on existing scripts,
+ * using space separated filenames. Recommanded values for compatibility with
+ * older versions :
+ * <code>define( 'PCLZIP_SEPARATOR', ' ' );</code>
+ * Recommanded values for smart separation of filenames.
+ */
+define( 'PCLZIP_SEPARATOR', ',' );
+
+/**
+ * Error configuration
+ *
+ * 0 : PclZip Class integrated error handling
+ * 1 : PclError external library error handling. By enabling this you must
+ *     ensure that you have included PclError library.
+ * [2,...] : reserved for future use
+ */
+define( 'PCLZIP_ERROR_EXTERNAL', 0 );
 
   // ----- Optional static temporary directory
   //       By default temporary files are generated in the script current
@@ -137,7 +146,7 @@
   define( 'PCLZIP_CB_POST_EXTRACT', 78002 );
   define( 'PCLZIP_CB_PRE_ADD', 78003 );
   define( 'PCLZIP_CB_POST_ADD', 78004 );
-  /* For futur use
+  /* For future use
   define( 'PCLZIP_CB_PRE_LIST', 78005 );
   define( 'PCLZIP_CB_POST_LIST', 78006 );
   define( 'PCLZIP_CB_PRE_DELETE', 78007 );